Skip to main content
This release is 2 versions behind 0.14.0 — the latest version of @dklab/oak-routing-ctrl. Jump to latest

Built and signed on GitHub Actions

TypeScript Decorators for easy scaffolding API services with the oak framework (jsr:@oak/oak)

This package works with Cloudflare Workers, Node.js, Deno, Bun
This package works with Cloudflare Workers
This package works with Node.js
This package works with Deno
This package works with Bun
JSR Score
100%
Published
2 months ago (0.12.2)
f
Controller

Decorator that should be used on the Controller Class

T
ControllerMethodArg

literal keywords that can be used as arguments for the @ControllerMethodArgs decorator; these keywords MUST appear in the same order that their counterpart arguments show up in the actual (decorated) handler function

f
ControllerMethodArgs

Decorator that should be used on the Controller Method when we need to refer to the request body, param, query, etc. in the Method Body

f
Delete

Decorator that should be used on the Controller Class Method for DELETE endpoints

f
Get

Decorator that should be used on the Controller Class Method for GET endpoints

f
Head

Decorator that should be used on the Controller Class Method for HEAD endpoints

T
OakOpenApiSpec
No documentation available
f
Options

Decorator that should be used on the Controller Class Method for OPTIONS endpoints

f
Patch

Decorator that should be used on the Controller Class Method for PATCH endpoints

f
Post

Decorator that should be used on the Controller Class Method for POST endpoints

f
Put

Decorator that should be used on the Controller Class Method for PUT endpoints

f
useOak

entry method to supercharge an oak application with routing-controllers -like capabilities (i.e. Controller Class and Method Decorators)

f
useOakServer

entry method to supercharge an oak application with routing-controllers -like capabilities (i.e. Controller Class and Method Decorators)

f
useOas

helper method to enable Open API Spec for the routes declared with oak-routing-ctrl decorators

v
z

entry to the Zod API, enhanced with @asteasolutions/zod-to-openapi; for usage documentation please refer to https://github.com/asteasolutions/zod-to-openapi?tab=readme-ov-file#purpose-and-quick-example

T
zInfer

re-exported z.infer type inference API; for usage documentation please refer to https://github.com/colinhacks/zod?tab=readme-ov-file#type-inference