@peregrine/koa-with-decorators NPM

node version

Koa with decorators

Library for using Koa with decorators

Notes

Make sure to enable and set the experimentalDecorators flag to true in your tsconfig.json

Decorators

decorator	type	required	aliases	description
@HttpGet	method	yes	@GET	Listen for HTTP GET requests
@HttpPost	method	yes	@POST	Listen for HTTP POST requests
@HttpPut	method	yes	@PUT	Listen for HTTP PUT requests
@HttpPatch	method	yes	@PATCH	Listen for HTTP PATCH requests
@HttpDelete	method	yes	@DELETE	Listen for HTTP DELETE requests
@HttpOptions	method	yes	@OPTIONS	Listen for HTTP OPTIONS requests
@HttpHead	method	yes	@HEAD	Listen for HTTP HEAD requests
@HttpAll	method	only if @Path is not set		Listen for all HTTP requests
@Path(path: string)	method	no (default path is `/`)		Attaches the method to the specified path
@Controller(path: string)	class	no (default path is `/`)		Adds a prefix to all paths in this method

Demo

import { HttpGet, HttpPost, Path, Controller, createRouter, DefaultStatusCode, CachedFor } from "@peregrine/koa-with-decorators"
import Koa, { Context } from "koa"
import Router from "@koa/router"
import bodyParser from "koa-bodyparser"

interface Pet {
    id: number
    name: string
    kind: string
}

@Controller("pets")
class PetsController {
    public constructor(private readonly petsList: Pet[]) {}

    @HttpGet
    @DefaultStatusCode(200)
    @CachedFor(4, "minutes")
    public getAllPets({ response }: Context): void {
        response.body = this.petsList
    }

    @HttpGet
    @Path("/:id")
    @DefaultStatusCode(200)
    @CachedFor(4, "minutes")
    public getPetById(ctx: Context): void {
        const petId = parseInt(ctx.params.id)
        const pet = this.petsList.find(it => it.id === petId) ?? null

        if (pet !== null) {
            ctx.response.body = pet
        } else {
            ctx.response.status = 404
        }
    }

    @HttpPost
    @DefaultStatusCode(201)
    public addPet(ctx: Context): void {
        const newPet = ctx.request.body
        this.petsList.add(newPet)
        ctx.response.body = newPet
    }
}

const myPets: Pet[] = [{ id: 1, name: "Maya", kind: "Macaw" }]

const petsRouter: Router = createRouter(new PetsController(myPets))

const koa = new Koa()
koa.use(bodyParser())

koa.use(petsRouter.routes())
koa.use(petsRouter.allowedMethods())

koa.listen(8080)

@koa/router @types/koa__router

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago