Skip to main content

Interface: SendFileOptions

Defined in: src/types/express/FileOptions.ts:13

Extends​

Properties​

acceptRanges?​

optional acceptRanges: boolean

Defined in: src/types/express/SendOptions.ts:17

Name​

acceptRanges

Description​

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.

Default​

true

Inherited from​

SendOptions.acceptRanges

cacheControl?​

optional cacheControl: boolean

Defined in: src/types/express/SendOptions.ts:27

Name​

cacheControl

Description​

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

Default​

true

Inherited from​

SendOptions.cacheControl

dotfiles?​

optional dotfiles: "allow" | "deny" | "ignore"

Defined in: src/types/express/SendOptions.ts:43

Name​

dotfiles

Description​

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.

Default​

'ignore'

Inherited from​

SendOptions.dotfiles

end?​

optional end: number

Defined in: src/types/express/SendOptions.ts:52

Name​

end

Description​

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.

Inherited from​

SendOptions.end

etag?​

optional etag: boolean

Defined in: src/types/express/SendOptions.ts:61

Name​

etag

Description​

Enable or disable etag generation, defaults to true.

Default​

true

Inherited from​

SendOptions.etag

extensions?​

optional extensions: string | boolean | string[]

Defined in: src/types/express/SendOptions.ts:72

Name​

extensions

Description​

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.

Inherited from​

SendOptions.extensions

headers?​

optional headers: Record<string, unknown>

Defined in: src/types/express/FileOptions.ts:15

Object containing HTTP headers to serve with the file.

immutable?​

optional immutable: boolean

Defined in: src/types/express/SendOptions.ts:83

Name​

immutable

Description​

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

Inherited from​

SendOptions.immutable

index?​

optional index: string | boolean | string[]

Defined in: src/types/express/SendOptions.ts:91

Name​

index

Description​

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.

Inherited from​

SendOptions.index

lastModified?​

optional lastModified: boolean

Defined in: src/types/express/SendOptions.ts:100

Name​

lastModified

Description​

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

Inherited from​

SendOptions.lastModified

maxAge?​

optional maxAge: string | number

Defined in: src/types/express/SendOptions.ts:109

Name​

maxAge

Description​

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

Inherited from​

SendOptions.maxAge

root?​

optional root: string

Defined in: src/types/express/SendOptions.ts:117

Name​

root

Description​

Serve files relative to path.

Inherited from​

SendOptions.root

start?​

optional start: number

Defined in: src/types/express/SendOptions.ts:126

Name​

start

Description​

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.

Inherited from​

SendOptions.start