87 lines
3.5 KiB
TypeScript
87 lines
3.5 KiB
TypeScript
// Type definitions for serve-static 1.7.1
|
|
// Project: https://github.com/expressjs/serve-static
|
|
// Definitions by: Uros Smolnik <https://github.com/urossmolnik/>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
|
|
/* =================== USAGE ===================
|
|
|
|
import * as serveStatic from "serve-static";
|
|
app.use(serveStatic("public/ftp", {"index": ["default.html", "default.htm"]}))
|
|
|
|
=============================================== */
|
|
|
|
/// <reference path="../express-serve-static-core/express-serve-static-core.d.ts" />
|
|
/// <reference path="../mime/mime.d.ts" />
|
|
|
|
declare module "serve-static" {
|
|
import * as express from "express-serve-static-core";
|
|
|
|
/**
|
|
* Create a new middleware function to serve files from within a given root directory.
|
|
* The file to serve will be determined by combining req.url with the provided root directory.
|
|
* When a file is not found, instead of sending a 404 response, this module will instead call next() to move on to the next middleware, allowing for stacking and fall-backs.
|
|
*/
|
|
function serveStatic(root: string, options?: {
|
|
/**
|
|
* Set how "dotfiles" are treated when encountered. A dotfile is a file or directory that begins with a dot (".").
|
|
* Note this check is done on the path itself without checking if the path actually exists on the disk.
|
|
* If root is specified, only the dotfiles above the root are checked (i.e. the root itself can be within a dotfile when when set to "deny").
|
|
* The default value is 'ignore'.
|
|
* 'allow' No special treatment for dotfiles
|
|
* 'deny' Send a 403 for any request for a dotfile
|
|
* 'ignore' Pretend like the dotfile does not exist and call next()
|
|
*/
|
|
dotfiles?: string;
|
|
|
|
/**
|
|
* Enable or disable etag generation, defaults to true.
|
|
*/
|
|
etag?: boolean;
|
|
|
|
/**
|
|
* Set file extension fallbacks. When set, if a file is not found, the given extensions will be added to the file name and search for.
|
|
* The first that exists will be served. Example: ['html', 'htm'].
|
|
* The default value is false.
|
|
*/
|
|
extensions?: string[];
|
|
|
|
/**
|
|
* By default this module will send "index.html" files in response to a request on a directory.
|
|
* To disable this set false or to supply a new index pass a string or an array in preferred order.
|
|
*/
|
|
index?: boolean|string|string[];
|
|
|
|
/**
|
|
* Enable or disable Last-Modified header, defaults to true. Uses the file system's last modified value.
|
|
*/
|
|
lastModified?: boolean;
|
|
|
|
/**
|
|
* Provide a max-age in milliseconds for http caching, defaults to 0. This can also be a string accepted by the ms module.
|
|
*/
|
|
maxAge?: number|string;
|
|
|
|
/**
|
|
* Redirect to trailing "/" when the pathname is a dir. Defaults to true.
|
|
*/
|
|
redirect?: boolean;
|
|
|
|
/**
|
|
* Function to set custom headers on response. Alterations to the headers need to occur synchronously.
|
|
* The function is called as fn(res, path, stat), where the arguments are:
|
|
* res the response object
|
|
* path the file path that is being sent
|
|
* stat the stat object of the file that is being sent
|
|
*/
|
|
setHeaders?: (res: express.Response, path: string, stat: any) => any;
|
|
}): express.Handler;
|
|
|
|
import * as m from "mime";
|
|
|
|
namespace serveStatic {
|
|
var mime: typeof m;
|
|
}
|
|
|
|
export = serveStatic;
|
|
}
|