@types/koa-send

What is @types/koa-send?

@types/koa-send provides TypeScript definitions for the koa-send package, which is used to serve static files in a Koa application.

What are @types/koa-send's main functionalities?

Serving Static Files

This feature allows you to serve static files from a specified path. In this example, when the user accesses the '/static' route, the server will respond with the file located at 'path/to/file.txt'.

const Koa = require('koa');
const send = require('koa-send');
const app = new Koa();

app.use(async (ctx) => {
  if (ctx.path === '/static') {
    await send(ctx, 'path/to/file.txt');
  }
});

app.listen(3000);

Setting Root Directory

This feature allows you to set a root directory for serving static files. In this example, the server will look for 'file.txt' in the 'public' directory located in the current directory.

const Koa = require('koa');
const send = require('koa-send');
const app = new Koa();

app.use(async (ctx) => {
  if (ctx.path === '/static') {
    await send(ctx, 'file.txt', { root: __dirname + '/public' });
  }
});

app.listen(3000);

Setting Cache Control

This feature allows you to set cache control headers for the served files. In this example, the 'maxAge' option is set to 1 hour, meaning the file will be cached for 1 hour.

const Koa = require('koa');
const send = require('koa-send');
const app = new Koa();

app.use(async (ctx) => {
  if (ctx.path === '/static') {
    await send(ctx, 'file.txt', { maxAge: 1000 * 60 * 60 }); // 1 hour
  }
});

app.listen(3000);

Other packages similar to @types/koa-send

@types/koa-static

@types/koa-static provides TypeScript definitions for the koa-static package, which is another middleware for serving static files in a Koa application. Unlike koa-send, koa-static is specifically designed for serving static files and directories, making it simpler to use for that purpose.

@types/serve-static

@types/serve-static provides TypeScript definitions for the serve-static package, which is used to serve static files in Express applications. While it is designed for Express, it can be used with Koa through the koa-connect package, offering similar functionality to koa-send.

README

Installation

npm install --save @types/koa-send

Summary

This package contains type definitions for koa-send (https://github.com/koajs/send).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/koa-send.

index.d.ts

import { ParameterizedContext } from "koa";

import { Stats } from "fs";

declare function send(ctx: ParameterizedContext, path: string, opts?: send.SendOptions): Promise<string>;

declare namespace send {
    type SetHeaders = (res: ParameterizedContext["res"], path: string, stats: Stats) => any;

    interface SendOptions {
        /** Browser cache max-age in milliseconds. (defaults to 0) */
        maxage?: number | undefined;
        maxAge?: SendOptions["maxage"] | undefined;
        /** Tell the browser the resource is immutable and can be cached indefinitely. (defaults to false) */
        immutable?: boolean | undefined;
        /** Allow transfer of hidden files. (defaults to false) */
        hidden?: boolean | undefined;
        /** Root directory to restrict file access. (defaults to '') */
        root?: string | undefined;
        /** Name of the index file to serve automatically when visiting the root location. (defaults to none) */
        index?: string | false | undefined;
        /** Try to serve the gzipped version of a file automatically when gzip is supported by a client and if the requested file with .gz extension exists. (defaults to true). */
        gzip?: boolean | undefined;
        /** Try to serve the brotli version of a file automatically when brotli is supported by a client and if the requested file with .br extension exists. (defaults to true). */
        brotli?: boolean | undefined;
        /** If not false (defaults to true), format the path to serve static file servers and not require a trailing slash for directories, so that you can do both /directory and /directory/. */
        format?: boolean | undefined;
        /** Function to set custom headers on response. */
        setHeaders?: SetHeaders | undefined;
        /** Try to match extensions from passed array to search for file when no extension is sufficed in URL. First found is served. (defaults to false) */
        extensions?: string[] | false | undefined;
    }
}

export = send;

Additional Details

• Last updated: Wed, 18 Oct 2023 05:47:07 GMT
• Dependencies: @types/koa

Credits

These definitions were written by Peter Safranek, and Tomek Łaziuk.