Interface SendFileOptions

interface SendFileOptions {
    acceptRanges?: boolean;
    cacheControl?: boolean;
    dotfiles?: "ignore" | "allow" | "deny";
    end?: number;
    etag?: boolean;
    extensions?: string | boolean | string[];
    headers?: Record<string, unknown>;
    immutable?: boolean;
    index?: string | boolean | string[];
    lastModified?: boolean;
    maxAge?: string | number;
    root?: string;
    start?: number;
}

Hierarchy (view full)

Properties

acceptRanges? cacheControl? dotfiles? end? etag? extensions? headers? immutable? index? lastModified? maxAge? root? start?

Properties

Optional acceptRanges

acceptRanges?: boolean

Enable or disable accepting ranged requests, defaults to true. Disabling this will not send Accept-Ranges and ignore the contents of the Range request header.

Optional cacheControl

cacheControl?: boolean

Enable or disable setting Cache-Control response header, defaults to true. Disabling this will ignore the maxAge option.

Optional dotfiles

dotfiles?: "ignore" | "allow" | "deny"

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"). '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 404. The default value is similar to 'ignore', with the exception that this default will not ignore the files within a directory that begins with a dot, for backward-compatibility.

Optional end

end?: number

Byte offset at which the stream ends, defaults to the length of the file minus 1. The end is inclusive in the stream, meaning end: 3 will include the 4th byte in the stream.

Optional etag

etag?: boolean

Enable or disable etag generation, defaults to true.

Optional extensions

extensions?: string | boolean | string[]

If a given file doesn't exist, try appending one of the given extensions, in the given order. By default, this is disabled (set to false). An example value that will serve extension-less HTML files: ['html', 'htm']. This is skipped if the requested file already has an extension.

Optional headers

headers?: Record<string, unknown>

Object containing HTTP headers to serve with the file.

Optional immutable

immutable?: boolean

Enable or disable the immutable directive in the Cache-Control response header, defaults to false. If set to true, 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.

Default

false

Optional index

index?: string | boolean | string[]

By default send supports "index.html" files, to disable this set false or to supply a new index pass a string or an array in preferred order.

Optional lastModified

lastModified?: boolean

Enable or disable Last-Modified header, defaults to true. Uses the file system's last modified value.

Optional maxAge

maxAge?: string | number

Provide a max-age in milliseconds for http caching, defaults to 0. This can also be a string accepted by the ms module.

Optional root

root?: string

Serve files relative to path.

Optional start

start?: number

Byte offset at which the stream starts, defaults to 0. The start is inclusive, meaning start: 2 will include the 3rd byte in the stream.

Settings

Member Visibility

Theme

On This Page

acceptRangescacheControldotfilesendetagextensionsheadersimmutableindexlastModifiedmaxAgerootstart