withMiddleware.md

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

---

elections-cpl.api.hscc.bdpa.org / src/backend/middleware / withMiddleware

Function: withMiddleware()

withMiddleware<PassedOptions>(pagesHandler, params): (req, res) => Promise<void>

Primary middleware runner for the REST API. Decorates a request handler.

Passing undefined as handler or not calling res.end() (and not sending headers) in your handler or use chain will trigger an HTTP 501 Not Implemented response. This can be used to to stub out endpoints and their middleware for later implementation.

Type parameters

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

Parameters

• pagesHandler: undefined | NextApiHandler

• params

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

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

• params.descriptor: undefined | string

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

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

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

Returns

Function

Parameters

• req: NextApiRequest

• res: NextApiResponse

Returns

Promise<void>

Source

src/backend/middleware.ts:63