updated .static jsvm docs

This commit is contained in:
Gani Georgiev
2026-04-02 08:06:51 +03:00
parent 3a893d15ad
commit 5cb66bd52f
4 changed files with 3879 additions and 3839 deletions

File diff suppressed because it is too large Load Diff

View File

@@ -1162,10 +1162,28 @@ declare namespace $apis {
/**
* Route handler to serve static directory content (html, js, css, etc.).
*
* If a file resource is missing and indexFallback is set, the request
* will be forwarded to the base index.html (useful for SPA).
* If a file resource is missing and indexFallback is true, the request
* will be forwarded to the base index.html (useful for SPA with pretty urls).
*
* NB! Expects the route to have a "{path...}" wildcard parameter.
*
* Special redirects:
*
* - if "path" is a file that ends in index.html, it is redirected to its non-index.html version (eg. /test/index.html -> /test/)
* - if "path" is a directory that has index.html, the index.html file is rendered,
* otherwise if missing - returns 404 or fallback to the root index.html if indexFallback is true
*
* Example:
*
* ` + "```" + `js
* // serves static files from the provided dir string path (it will be wrapped in $os.dirFS())
* routerAdd("GET", "/{path...}", $apis.static("/path/to/public", false))
*
* // serves static files from the explicit fs.FS value ($os.dirFS(), $os.openRoot().fs(), etc.)
* routerAdd("GET", "/{path...}", $apis.static($os.dirFS("/path/to/public"), false))
* ` + "```" + `
*/
function static(dir: string, indexFallback: boolean): (e: core.RequestEvent) => void
function static(dirOrFS: string|fs.FS, indexFallback: boolean): (e: core.RequestEvent) => void
let requireGuestOnly: apis.requireGuestOnly
let requireAuth: apis.requireAuth