StaticFilesOptionsType

StaticFilesOptionsType = object

Defined in: src/http/static/StaticFilesOptions.ts:9

Plain settings shape for the static-file directives.

Properties

browse?

readonly optional browse?: boolean

Defined in: src/http/static/StaticFilesOptions.ts:13

Render an HTML listing when a directory has no usable index. Default false.

---

cacheControl?

readonly optional cacheControl?: string

Defined in: src/http/static/StaticFilesOptions.ts:15

Cache-Control header value. Default: header omitted.

---

contentType?

readonly optional contentType?: string

Defined in: src/http/static/StaticFilesOptions.ts:29

getFromFile only: force this exact content-type.

---

contentTypes?

readonly optional contentTypes?: Readonly<Record<string, string>>

Defined in: src/http/static/StaticFilesOptions.ts:27

Per-extension content-type overrides (ext → full content-type).

---

dotfiles?

readonly optional dotfiles?: "deny" | "allow"

Defined in: src/http/static/StaticFilesOptions.ts:23

Dotfile policy. Default 'deny' (404 + hidden from listings).

---

etag?

readonly optional etag?: boolean

Defined in: src/http/static/StaticFilesOptions.ts:17

Emit a weak ETag (size + mtime) and honour If-None-Match. Default true.

---

indexFiles?

readonly optional indexFiles?: readonly string[]

Defined in: src/http/static/StaticFilesOptions.ts:11

Index files tried for a directory request. Default ['index.html']; [] disables.

---

lastModified?

readonly optional lastModified?: boolean

Defined in: src/http/static/StaticFilesOptions.ts:19

Emit Last-Modified and honour If-Modified-Since. Default true.

---

maxFileSize?

readonly optional maxFileSize?: number

Defined in: src/http/static/StaticFilesOptions.ts:31

Max file size buffered into memory. Default 50 MiB; larger → 413.

---

ranges?

readonly optional ranges?: boolean

Defined in: src/http/static/StaticFilesOptions.ts:21

Honour a single Range request (206 / 416). Default true.

---

symlinks?

readonly optional symlinks?: "within-root" | "follow"

Defined in: src/http/static/StaticFilesOptions.ts:25

Symlink policy. Default 'within-root' (a link escaping the root → 404).