@saflib/express
@saflib/express
Packages which implement express servers should import and use this package.
Interfaces
| Interface | Description |
|---|---|
| GlobalMiddlewareOptions | Options for creating global middleware. |
| ScopedMiddlewareOptions | Options for creating scoped middleware. |
| StartServerOptions | Options when starting an Express server. |
Functions
| Function | Description |
|---|---|
| createErrorMiddleware | Middleware which should be placed after all routes. |
| createGlobalMiddleware | Middleware which should be put at the top of the middleware stack, and run for every request. |
| createHandler | Wrapper for Express handlers. Promisifies the handler, ensuring any uncaught exceptions get passed to next. |
| createScopedMiddleware | Middleware which should only be applied to a subset of routes in an express server. This middleware all depends on the OpenAPI spec for those routes. |
| makeAdminHeaders | - |
| makeUserHeaders | - |
| startExpressServer | Given an Express app and options, starts the server and sets it up for graceful shutdown. |