next-test-api-route-handler • Docs
next-test-api-route-handler / NtarhInitPagesRouter
The parameters expected by testApiHandler when using pagesHandler.
NtarhInit<NextResponseJsonType>
• NextResponseJsonType = unknown
optionalappHandler:undefined
pagesHandler:
NextApiHandler<any> |object
The actual Pages Router route handler under test. It should be an async
function that accepts NextApiRequest and NextApiResult objects (in
that order) as its two parameters.
Note that type checking for res.send and similar methods was retired in
NTARH@4. Only the response.json method returned by NTARH's fetch wrapper
will have a typed result.
optionalparams:Record<string,unknown>
params is passed directly to the handler and represents processed dynamic
routes. This should not be confused with query string parsing, which is
handled automatically.
params: { id: 'some-id' } is shorthand for paramsPatcher: (params) => { params.id = 'some-id' }. This is useful for quickly setting many params at
once.
optionalparamsPatcher: (params) =>Promisable<void|Record<string,unknown>>
A function that receives params, an object representing "processed"
dynamic route parameters. Modifications to params are passed directly to
the handler. You can also return a custom object from this function which
will replace params entirely.
Parameter patching should not be confused with query string parsing, which is handled automatically.
• params: Record<string, unknown>
Promisable<void | Record<string, unknown>>
optionalrejectOnHandlerError:boolean
If false, errors thrown from within a handler are kicked up to Next.js's
resolver to deal with, which is what would happen in production. If true,
the testApiHandler function will reject immediately instead.
You should use rejectOnHandlerError whenever you want to manually handle
an error that bubbles up from your handler (which is especially true if
you're using expect within your handler) or when you notice a false
negative despite exceptions being thrown.
falseNtarhInit.rejectOnHandlerError
optionalrequestPatcher: (request) =>Promisable<void>
A function that receives an IncomingMessage object. Use this function
to edit the request before it's injected into the handler.
Note: all replacement IncomingMessage.header names must be
lowercase.
• request: IncomingMessage
Promisable<void>
optionalresponsePatcher: (res) =>Promisable<void>
A function that receives a ServerResponse object. Use this function
to edit the response before it's injected into the handler.
• res: ServerResponse<IncomingMessage>
Promisable<void>
test: (
parameters) =>Promisable<void>
test is a function that runs your test assertions. This function receives
one destructured parameter: fetch, which is equivalent to
globalThis.fetch but with the first parameter omitted.
• parameters
• parameters.fetch
Promisable<void>
optionalurl:string
url: 'your-url' is shorthand for requestPatcher: (req) => { req.url = 'your-url' }