@types/serve-static

  • Version 1.13.10
  • Published
  • 7.77 kB
  • 2 dependencies
  • MIT license

Install

npm i @types/serve-static
yarn add @types/serve-static
pnpm add @types/serve-static

Overview

TypeScript definitions for serve-static

Index

Variables

variable mime

var mime: any;

    Functions

    function serveStatic

    serveStatic: typeof serveStatic;
    • 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.

    Interfaces

    interface RequestHandler

    interface RequestHandler<R extends http.ServerResponse> {}

      call signature

      (request: http.IncomingMessage, response: R, next: () => void): any;

        interface RequestHandlerConstructor

        interface RequestHandlerConstructor<R extends http.ServerResponse> {}

          property mime

          mime: typeof m;

            call signature

            (root: string, options?: ServeStaticOptions<R>): RequestHandler<R>;

              interface ServeStaticOptions

              interface ServeStaticOptions<R extends http.ServerResponse = http.ServerResponse> {}

                property cacheControl

                cacheControl?: boolean | undefined;
                • Enable or disable setting Cache-Control response header, defaults to true. Disabling this will ignore the immutable and maxAge options.

                property dotfiles

                dotfiles?: string | undefined;
                • 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()

                property etag

                etag?: boolean | undefined;
                • Enable or disable etag generation, defaults to true.

                property extensions

                extensions?: string[] | false | undefined;
                • 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.

                property fallthrough

                fallthrough?: boolean | undefined;
                • Let client errors fall-through as unhandled requests, otherwise forward a client error. The default value is true.

                property immutable

                immutable?: boolean | undefined;
                • Enable or disable the immutable directive in the Cache-Control response header. If enabled, the maxAge option should also be specified to enable caching. The immutable directive will prevent supported clients from making conditional requests during the life of the maxAge option to check if the file has changed.

                property index

                index?: boolean | string | string[] | undefined;
                • 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.

                property lastModified

                lastModified?: boolean | undefined;
                • Enable or disable Last-Modified header, defaults to true. Uses the file system's last modified value.

                property maxAge

                maxAge?: number | string | undefined;
                • Provide a max-age in milliseconds for http caching, defaults to 0. This can also be a string accepted by the ms module.

                property redirect

                redirect?: boolean | undefined;
                • Redirect to trailing "/" when the pathname is a dir. Defaults to true.

                property setHeaders

                setHeaders?: ((res: R, path: string, stat: any) => any) | undefined;
                • 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

                Package Files (1)

                Dependencies (2)

                Dev Dependencies (0)

                No dev dependencies.

                Peer Dependencies (0)

                No peer dependencies.

                Badge

                To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/serve-static.

                • Markdown
                  [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/serve-static)
                • HTML
                  <a href="https://www.jsdocs.io/package/@types/serve-static"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>