This release is 6 versions behind 17.1.3 — the latest version of @oak/oak. Jump to latest

@oak/oak@16.0.0
Built and signed on GitHub Actions
Built and signed on GitHub Actions

A middleware framework for handling HTTP with Deno, Node.js, Bun and Cloudflare Workers 🐿️🦕🥟⚙️

Published

8 months ago (16.0.0)

class Layer

An internal class used to group together middleware when using multiple middlewares with a router.

Constructors

new



Layer(path: string,
methods: HTTPMethods[],
middleware: RouterMiddleware<R, P, S> | RouterMiddleware<R, P, S>[],
unnamed 3?: LayerOptions,
)



R extends string



P extends RouteParams<R> = RouteParams<R>



S extends State = Record<string, any>



methods: HTTPMethods[]

abstract



name: string



path: string



stack: RouterMiddleware<R, P, S>[]



[Symbol.for("Deno.customInspect")](inspect: (value: unknown) => string): string



[Symbol.for("nodejs.util.inspect.custom")](depth: number,
options: any,
inspect: (value: unknown,
options?: unknown,
) => string,
): any



captures(path: string): string[]



clone(): Layer<R, P, S>



match(path: string): boolean



param(param: string,
fn: RouterParamMiddleware<any, any, any>,
): this



params(captures: string[],
existingParams?: RouteParams<R>,
): RouteParams<R>



setPrefix(prefix: string): this



toJSON(): Route<any, any, any>



url(params?: RouteParams<R>,
options?: UrlOptions,
): string

Add Package

deno add jsr:@oak/oak

Import symbol

import { Layer } from "@oak/oak/router";

---- OR ----

Import directly with a jsr specifier

import { Layer } from "jsr:@oak/oak/router";

Add Package

npx jsr add @oak/oak

Import symbol

import { Layer } from "@oak/oak/router";

Add Package

yarn dlx jsr add @oak/oak

Import symbol

import { Layer } from "@oak/oak/router";

Add Package

pnpm dlx jsr add @oak/oak

Import symbol

import { Layer } from "@oak/oak/router";

Add Package

bunx jsr add @oak/oak

Import symbol

import { Layer } from "@oak/oak/router";