StaticServeOptions

Defined in: src/util/types.ts:427

Type Parameters

T

T extends Record<string, any>

Properties

dotfiles?

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

Defined in: src/util/types.ts:458

How to treat dotfiles (files starting with .) ‘allow’: Serve them ‘deny’: Return 403 ‘ignore’: Return 404

Default

'ignore'

---

exclude?

optional exclude: (string | RegExp)[]

Defined in: src/util/types.ts:462

Regex or glob patterns to exclude

---

extensions?

optional extensions: string[]

Defined in: src/util/types.ts:467

Try to append these extensions to the path if the file is not found. e.g. [‘html’, ‘htm’]

---

hooks?

optional hooks: StaticServeHooks<T>

Defined in: src/util/types.ts:450

Hooks to intercept requests/responses.

---

index?

optional index: string | string[]

Defined in: src/util/types.ts:446

Index file(s) to look for when a directory is requested.

Default

['index.html', 'index.htm']

---

listDirectory?

optional listDirectory: boolean

Defined in: src/util/types.ts:441

Whether to list directory contents if no index file is found.

Security Note: Directory listing is disabled by default to prevent information disclosure. Enable this only if you specifically need it and understand the security implications.

Default

false

---

openapi?

optional openapi: MethodAPISpec

Defined in: src/util/types.ts:471

OpenAPI specification for the static route.

---

root?

optional root: string

Defined in: src/util/types.ts:432

Root directory to serve files from. Can be an absolute path or relative to the CWD.