ServeContext | /middleware/serve.ts | oak@v17.1.3

method ServeContext.prototype.assert

import { ServeContext } from "https://dotland-vbqsvsrpfncg.deno-staging.dev/x/oak@v17.1.3/middleware/serve.ts?p=prototype.assert&s=ServeContext";

assert(

condition: unknown,

status?: ErrorStatus,

message?: string,

props?: Record<string, unknown> & Omit<HttpErrorOptions, "status">,

): asserts condition

Asserts the condition and if the condition fails, creates an HTTP error with the provided status (which defaults to 500). The error status by default will be set on the .response.status.

Because of limitation of TypeScript, any assertion type function requires specific type annotations, so the ServeContext type should be used even if it can be inferred from the context.

Parameters

condition: unknown[src]

optional

status: ErrorStatus[src]

optional

message: string[src]

optional

props: Record<string, unknown> & Omit<HttpErrorOptions, "status">[src]

Returns

asserts condition[src]