middlewareFactory.md

elections-cpl.api.hscc.bdpa.org • Docs

---

elections-cpl.api.hscc.bdpa.org / lib/next-api-glue / middlewareFactory

Function: middlewareFactory()

middlewareFactory<Options>(__namedParameters): <PassedOptions>(pagesHandler, params) => (req, res) => Promise<void>

Returns a withMiddleware function decorated with a preset configuration. withMiddleware optionally accepts its usual parameters, which will be appended onto the arguments to withMiddlewareFactory (the "preset parameters"); however, note that passed option keys will overwrite their preset counterparts.

Useful when you don't want to repeatedly import, configure, and list a bunch of middleware every time you want to call withMiddleware.

Type parameters

• Options extends Record<string, unknown> = Record<string, unknown>

Parameters

• __namedParameters

• __namedParameters.options?: Partial<NoInfer<Options> & object> & NoInfer<Options>

• __namedParameters.use: Middleware<NoInfer<Options>>[]

• __namedParameters.useOnError?: Middleware<NoInfer<Options>>[]

Returns

Function

Type parameters

• PassedOptions extends Record<string, unknown> = Record<string, unknown>

Parameters

• pagesHandler: undefined | NextApiHandler

• params

• params.appendUse?: Middleware<NoInfer<Options>>[]

• params.appendUseOnError?: Middleware<NoInfer<Options>>[]

• params.descriptor: undefined | string

• params.options?: Partial<NoInfer<Options> & object> & NoInfer<PassedOptions>

• params.prependUse?: Middleware<NoInfer<Options>>[]

• params.prependUseOnError?: Middleware<NoInfer<Options>>[]

Returns

Function

Parameters

• req: NextApiRequest

• res: NextApiResponse

Returns

Promise<void>

Source

lib/next-api-glue/index.ts:337