npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

koatty

v3.11.7

Published

Koa2 + Typescript = koatty. Use Typescript's decorator implement auto injection.

Downloads

350

Readme

koatty

Koa2 + Typescript + IOC = koatty.

Use Typescript's decorator implement IOC and AOP.

Version npmnpm Downloads

New features

  • HTTP、HTTPS、HTTP2、gRPC、WebSocket server.✔️
  • Support loading environment configuration, parsing command line parameters (process.argv) and environment variables (process.env).✔️
  • @ExceptionHandler() Register global exception handling.✔️
  • graceful shutdown and pre-exit event.✔️
  • custom decorator based on app events.✔️
  • GraphQL supporting. 💪
  • OpenTelemetry . 💪

Documentation

koatty_doc_CN (In progress💪)

Installation CLI tools

npm i -g koatty_cli

Quick Start

1.Create Project

kt new projectName

2. Install deps

cd ./projectName

npm i

3. Start up

npm run dev

// or
npm start

Code style

default Controller:

import { Controller, Autowired, GetMapping, RequestBody, PathVariable,
 PostMapping, RequestMapping, RequestMethod, Valid, Output } from "koatty";
import { TestDTO } from "../model/dto/TestDTO";
import { TestService } from "../service/TestService";
import { App } from "../App";

@Controller()
export class IndexController {
    app: App;
    ctx: KoattyContext;

    @Autowired()
    private testService: TestService;

    /**
     * constructor
     *
     */
    constructor(ctx: KoattyContext) {
        this.ctx = ctx;
    }

    @GetMapping('/')
    index() {
        return Output.ok("Hello, koatty!");
    }

    @RequestMapping("/:name", RequestMethod.ALL)
    async default(@PathVariable("name") @Valid("IsNotEmpty") name: string) {
        try {
            const info = await this.testService.sayHello(name);
            return Output.ok(this.ctx, "success", info);
        } catch (err: Error) {
            return Output.fail(this.ctx, err.message));
        }
    }

    @PostMapping("/test")
    @Validated() //need DTOClass
    test(@RequestParam() params: TestDTO) {
        return Output.ok(this.ctx, "test", params);
    }
}

How to do Unit Testing

only support jest UT framework now

import request from 'supertest';
import { ExecBootStrap } from 'koatty';
import { App } from '../src/App';

describe('UT example', () => {

  let app: KoattyApplication;
  beforeAll(async () => {
    jest.useFakeTimers();
    // test env
    process.env.KOATTY_ENV = 'ts-node';
    app = await ExecBootStrap()(App);
    // app.use(async (ctx: any) => {
    //   ctx.body = 'Hello, World!';
    // });
  });

  afterAll(done => {
    done();
    jest.clearAllMocks();
  });

  it('request', async () => {
    const res = await request(app.callback()).get('/');
    expect(res.status).toBe(200);
  });
});

How to debug

if you use vscode , edit the .vscode/launch.json , like this:

{
    "version": "0.2.0",
    "configurations": [
        {
            "type": "node",
            "request": "launch",
            "name": "TS Program",
            "args": [
                "${workspaceRoot}/src/App.ts" 
            ],
            "runtimeArgs": [
                "--nolazy",
                "-r",
                "ts-node/register"
            ],
            "sourceMaps": true,
            "cwd": "${workspaceRoot}",
            "protocol": "inspector",
            "outputCapture": "std",
            "internalConsoleOptions": "neverOpen"
        }
    ]
}

Select TS Program to debug run. Try to call http://localhost:3000/ .

Example

Check out the quick start example.