express-yaschema-ws-api-handler
Express support for handling WebSocket APIs declared using yaschema-ws-api.
Basic Example
export const stream = makeWsApi({
routeType: 'stream',
url: '/stream',
requests: {
ping: schema.object({ echo: schema.string().allowEmptyString().optional() }).optional(),
hello: schema.any().optional()
},
responses: {
pong: schema.object({
body: schema.string()
}),
hello: schema.object({
body: schema.string()
})
}
});
import expressWS, { WithWebsocketMethod } from 'express-ws';
…
expressWs(app);
const appWithWs = app as typeof app & WithWebsocketMethod;
registerWsApiHandler(
appWithWs,
api.stream,
{},
{
ping: async ({ input, output }) => output.pong({ body: `PONG${(input?.echo?.length ?? 0) > 0 ? ' ' : ''}${input?.echo ?? ''}` }),
hello: async ({ output }) => output.hello({ body: 'world' })
}
)
The options object passed to registerWsApiHandler
lets you override the validation mode and/or specify middleware.
Initializing Multiple Express Servers Simultaneously
If you happen to be potentially initializing multiple Express servers simultaneously (e.g. on different ports) and you're using Yaschema API for more than one of these servers, you will need to extend your Express
instance to support YaschemaApiExpressContextAccessor
by calling addYaschemaApiExpressContextAccessorToExpress(express, context)
before calling registerWsApiHandler
-- where context
should be unique for each Express server, and can be created using makeYaschemaApiExpressContext
.
Thanks
Thanks for checking it out. Feel free to create issues or otherwise provide feedback.
API Docs
Be sure to check out our other TypeScript OSS projects as well.