static-plugin/src/index.ts - Setu-TS documentation

Examples

import { StaticPlugin } from '@setu-ts/static-plugin';

app.register(StaticPlugin({
  root: './public',
  urlPrefix: '/assets',
}));

c

Static files service that serves files from a configured root directory.

serve(ctx: IRequestContext): Promise<HandlerResult>
Serves the static file addressed by the request context.

f

Creates a static file RouteHandler.

f

Creates a StaticPlugin that serves static files from a configured root directory.

I

Static files service interface.

serve(ctx: IRequestContext): Promise<HandlerResult>
Serves the static file addressed by the request context, applying the same conditional-request, Range, and encoding negotiation the mounted routes use — this and the route handler are one implementation, so both honour the plugin's configuration identically.

T

Options for configuring the StaticPlugin.

cacheControl: string | ((relativePath: string) => string)
Cache-Control header configuration (default: function returning immutable for hashed assets, must-revalidate for others).
compressed: boolean
Enable precompressed sidecar negotiation (default: true).
etag: boolean
Enable ETag generation (default: true).
fallback: string
Fallback file to serve for missing paths when Accept includes text/html (default: undefined). Used for SPA fallback.
fs: IFileSystem
The filesystem to use for file operations.
index: string
Index file to serve when a directory is requested (default: 'index.html'). Set to empty string '' to disable index resolution.
maxBufferBytes: number
Maximum file size to read fully into memory (default: 1MB). Files larger than this will use streaming when available.
ranges: boolean
Enable Range request handling (default: true).
root: string
Required. The filesystem directory to serve files from.
urlPrefix: string
URL prefix for static routes (default: '/').