Documentation / base / HttpFSOptions

Interface: HttpFSOptions

Defined in: libs/base/src/vfs/httpfs.ts:13

Options for HttpFS.

Properties

timeout?

optional timeout?: number

Defined in: libs/base/src/vfs/httpfs.ts:17

Request timeout in milliseconds for HTTP operations. Defaults to 30000.

---

headers?

optional headers?: Record<string, string>

Defined in: libs/base/src/vfs/httpfs.ts:21

Default headers to include with each HTTP request.

---

credentials?

optional credentials?: RequestCredentials

Defined in: libs/base/src/vfs/httpfs.ts:26

Fetch credentials policy for cross-origin requests. See RequestCredentials for allowed values.

---

urlResolver?

optional urlResolver?: (url) => string

Defined in: libs/base/src/vfs/httpfs.ts:36

Optional URL pre-processor. If provided, every incoming VFS path is first passed through this resolver to produce the final URL or path string.

Use cases:

• Rewriting logical VFS paths to CDN URLs
• Injecting cache-busting query params
• Mapping to object/data URLs

Parameters

url

string

Returns

string

---

directoryReader?

optional directoryReader?: HttpDirectoryReader | HttpDirectoryReader[]

Defined in: libs/base/src/vfs/httpfs.ts:41

One or more directory readers used to enumerate HTTP-backed directories. If not provided, directory listing is not supported.