@shadow-js/dusk/node

Everything @shadow-js/dusk/node exports, from the TSDoc of its entry point.

Functions#

• createFileKVStore: Creates the file store.
• isCompressible: Whether a content type is worth compressing: text, JSON, JavaScript, XML, SVG, WebAssembly.
• markProcessLocalStore: Records that a store keeps its entries in the memory of this process only.
• negotiateEncoding: Chooses a content coding from Accept-Encoding: the highest q-value wins, and a tie goes to brotli, then zstd (only where node:zlib has it), then gzip.
• node: The adapter for Node.js: writes server.mjs.
• safeSegments: Decodes a request path into safe segments.
• serve: Serves a handler over HTTP with Node's http module.
• workerInfo: Tells which process the caller runs in.

Interfaces#

• CompressOptions: Options of response compression.
• FileKVStoreOptions: Options of createFileKVStore.
• NodeAdapterOptions: Options of the node adapter.
• PoolControl: What the primary of a worker pool can do, on ServerHandle.pool.
• ServeOptions: Options of serve.
• ServerHandle: A running server.
• SignalTarget: The part of process the server uses for shutdown signals.
• StaticOptions: Options of static file serving.
• SuperviseOptions: Settings of the supervision of a worker pool.
• WorkerInfo: What workerInfo reports.

Types#

• Encoding: A content coding this server produces.