chubbyts-static-file

Description

A minimal static file handler for chubbyts-http-types.

Requirements

• node: 16
• @chubbyts/chubbyts-http-error: ^2.3.1
• @chubbyts/chubbyts-http-types: ^1.2.3

Installation

Through NPM as @chubbyts/chubbyts-static-file.

1npm i @chubbyts/chubbyts-static-file@^2.0.1

Usage

1import { createStaticFileHandler } from '@chubbyts/chubbyts-static-file/dist/handler';
2import type { ResponseFactory, StreamFromFileFactory } from '@chubbyts/chubbyts-http-types/dist/message-factory';
3import { createGetRoute } from '@chubbyts/chubbyts-framework/dist/router/route';
4
5const responseFactory: ResponseFactory = ...;
6const streamFromFileFactory: StreamFromFileFactory = ...;
7
8const handler = createStaticFileHandler(
9  responseFactory,
10  streamFromFileFactory,
11  '/path/to/public/directory',
12  (await import('../src/mimetypes')).default, // typescript / ecmascript module
13  // require('../src/mimetypes').default, // commonjs (cjs)
14);
15
16// for example as a fallback route matching everything
17const route = createGetRoute({
18  path: '/(.*)',
19  name: 'static_file',
20  handler,
21});

Copyright

2023 Dominik Zogg