API
Contents
Constants
Lib-static exports a constant named RESPONSE_CACHE_CONTROL.
RESPONSE_CACHE_CONTROL
Enum with the following members:
| Name | Current value | Description |
|---|---|---|
|
|
public, max-age=3600, stale-while-revalidate=60 |
Cache control for crawler requests |
|
|
private, no-store |
Cache control for development mode |
|
|
public, max-age=31536000, immutable |
Cache control for immutable resources |
|
|
public, max-age=0, must-revalidate |
Cache control to prevent caching |
|
|
public, max-age=10, s-maxage=3600, stale-while-revalidate=60 |
Cache control for safe requests |
defaultCacheControl
Function that returns a cache control header value.
It’s used as a callback and is the default value for the cacheControl option in the requestHandler function.
When yielded inside the requestHandler it gets passed the found resource, its content type and path.
Parameters
| Name | Type | Description |
|---|---|---|
|
contentType |
string |
The content type of the resource |
|
path |
string |
The path to the resource |
|
resource |
Resource |
The found resource |
See the webapp or mappings examples.
mappedRelativePath
mappedRelativePath is a function that takes a base path string and returns a RelativePathResolver function.
The returned function will resolve relative paths to resources "hosted" under the based base path.
It can be imported and used as a callback for the relativePath option of the requestHandler function.
See the mapped usage example.
requestHandler
This function handles requests for static resources.
Parameters
| Name | Type | Attributes | Description |
|---|---|---|---|
|
request |
Request |
<required> |
The request object |
|
options |
object |
<optional> |
Options object |
Options
| Name | Type | Default | Description |
|---|---|---|---|
|
cacheControl |
Function that returns the cache control header value |
||
|
contentType |
getMimeType |
Function that returns the content type header value |
|
|
etag |
boolean |
true |
Whether to include ETag header |
|
index |
string |
'index.html' |
Default file to serve when requesting a directory |
|
notFound |
notFoundResponse |
Function that returns the response object when the resource is not found |
|
|
relativePath |
getRelativeResourcePath |
Function that returns the relative path to the resource |
|
|
root |
string |
'/static' |
Root path to serve files from |
|
staticCompress |
boolean |
true |
Whether to serve precompressed files (*.br, *.gz) if available and supported by the browser |
|
throwErrors |
boolean |
true |
Whether to throw errors or return a response object |
Returns
Response : The response object.
spaNotFoundHandler
spaNotFoundHandler is a function that always returns a Response with the index.html Resource.
It can be imported and used as a callback for the notFound option of the requestHandler function.
Single page applications (SPA) typically consists of some static assets (stylesheets, fonts, images, etc…) and a single entrypoint file (e.g. index.html) that is responsible for routing and rendering the application.
Whenever a request doesn’t match a static asset, lib-static would by default return a 404 Response.
This is not desirable for an SPA, because the request might be to a client-side routed page, and not a missing static asset.
Such requests can happen when someone reloads or opens a bookmarked url to a client-side routed page.
In addition to routing to client-side "pages", the SPA should render a beautiful 404 page, when no route matches.
See the webapp usage example.
Types
Overview of the TS type definitions in this API:
CacheControlResolver
type CacheControlResolver = (params: CacheControlResolverParams) => string | nullCacheControlResolverParams
interface CacheControlResolverParams {
contentType?: string
path?: string
resource?: Resource
}ContentTypeResolver
type ContentTypeResolver = (params: ContentTypeResolverParams) => string | nullContentTypeResolverParams
interface ContentTypeResolverParams {
path?: string
resource?: Resource
}NotFoundHandler
type NotFoundHandler = (params: NotFoundHandlerParams) => ResponseNotFoundHandlerParams
interface NotFoundHandlerParams {
path: string
request: Request
cacheControl?: CacheControlResolver
contentType?: ContentTypeResolver
etag?: boolean
index?: string|false
root?: string
staticCompress?: boolean
throwErrors?: boolean
}RelativePathResolver
type RelativePathResolver = (req: Request) => stringRequestHandler
type RequestHandler = (request: Request, options?: RequestHandlerOptions) => ResponseRequestHandlerOptions
interface RequestHandlerOptions {
cacheControl?: CacheControlResolver
contentType?: ContentTypeResolver
etag?: boolean
index?: string|false
notFound?: NotFoundHandler
relativePath?: RelativePathResolver
root?: string
staticCompress?: boolean
throwErrors?: boolean
}