x/oak/context.ts

A middleware framework for handling HTTP with Deno, Node, Bun and Cloudflare Workers 🐿️ 🦕
Very Popular
Latest
method Context.prototype.assert
import { Context } from "https://dotland-vbqsvsrpfncg.deno-staging.dev/x/oak@v17.1.3/context.ts?p=prototype.assert&s=Context";

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 Context type should be used even if it can be inferred from the context.

Example

import { Context, Status } from "jsr:@oak/oak/";

export function mw(ctx: Context) {
  const body = ctx.request.body();
  ctx.assert(body.type === "json", Status.NotAcceptable);
  // process the body and send a response...
}

Parameters

condition: unknown[src]
optional
errorStatus: ErrorStatus
[src]
optional
message: string
[src]
optional
props: Record<string, unknown> & Omit<HttpErrorOptions, "status">
[src]

Returns

asserts condition[src]