mirror of
https://github.com/zhigang1992/DefinitelyTyped.git
synced 2026-05-12 11:51:10 +08:00
47 lines
2.1 KiB
TypeScript
47 lines
2.1 KiB
TypeScript
// Type definitions for koa-send 4.1
|
|
// Project: https://github.com/koajs/send
|
|
// Definitions by: Peter Safranek <https://github.com/pe8ter>
|
|
// Tomek Łaziuk <https://github.com/tlaziuk>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
// TypeScript Version: 2.3
|
|
|
|
import {
|
|
Context,
|
|
} from "koa";
|
|
|
|
import {
|
|
Stats,
|
|
} from "fs";
|
|
|
|
declare function send(ctx: Context, path: string, opts?: send.SendOptions): Promise<string>;
|
|
|
|
declare namespace send {
|
|
type SetHeaders = (res: Context["res"], path: string, stats: Stats) => any;
|
|
|
|
interface SendOptions {
|
|
/** Browser cache max-age in milliseconds. (defaults to 0) */
|
|
maxage?: number;
|
|
maxAge?: SendOptions["maxage"];
|
|
/** Tell the browser the resource is immutable and can be cached indefinitely. (defaults to false) */
|
|
immutable?: boolean;
|
|
/** Allow transfer of hidden files. (defaults to false) */
|
|
hidden?: boolean;
|
|
/** Root directory to restrict file access. (defaults to '') */
|
|
root?: string;
|
|
/** Name of the index file to serve automatically when visiting the root location. (defaults to none) */
|
|
index?: string;
|
|
/** 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;
|
|
/** 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;
|
|
/** 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;
|
|
/** Function to set custom headers on response. */
|
|
setHeaders?: SetHeaders;
|
|
/** 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;
|
|
}
|
|
}
|
|
|
|
export = send;
|