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

typhoonts

v1.1.2

Published

A lightweight and flexible TypeScript framework for building server-side applications.

Downloads

6,388

Readme

TyphoonTS

A robust and type-safe framework for building scalable web applications using TypeScript

Features

  • TypeScript-Only Framework
  • Decorators for Routes and Services
  • Middleware Support
  • Object Pool for Singleton Services
  • Session and Cookie Management
  • MVC Architecture
  • Dynamic Routing
  • Modular and Extensible
  • HTTP Server Creation
  • Service Injection

Installation

npm install typhoonts

Example Usage

Defining a Service

import { Service } from 'typhoonts';

@Service()
export class ExampleService {
    getExampleData() {
        return { message: 'Hello from the service!' };
    }
}

Defining a Controller

import { Controller, Get, Request, Response } from 'typhoonts';
import { ExampleService } from './services/ExampleService';
import { Inject } from 'typhoonts';

@Controller('/')
export class HomeController {
    @Inject(ExampleService)
    private exampleService!: ExampleService;

    @Get('/')
    getHome(req: Request, res: Response) {
        const data = this.exampleService.getExampleData();
        res.json(data);
    }

    @Post("/")
    save(req: Request, res: Response) {
        res.json({
            body: req.body,
            params: req.params,
            query: req.query,
        });
    }
}

Setting Up the Server

import { Server } from 'typhoonts';
import { HomeController } from './controllers/HomeController';
import { ExampleService } from './services/ExampleService';

const server = new Server({
    useBodyParser: true,
    useCookieParser: true,
    useSession: true,
    sessionOptions: { secret: 'my_secret_key' }
});

server.registerController(HomeController);

server.listen(8000, () => {
    console.log('Server is running on http://localhost:8000');
});

Dynamic URL Example

import { Controller, Get, Request, Response } from 'typhoonts';

@Controller('/users')
export class UserController {
    @Get('/:id')
    getUser(req: Request, res: Response) {
        const userId = req.params.id;
        res.send(`User ID is ${userId}`)
    }
}

Controller with @ResponseBody()

import { Controller, Get, Request, Response } from 'typhoonts';

@Controller('/users')
export class UserController {
    @Post("/")
    @ResponseBody()
    save(req: Request, res: Response) {
        return {
            body: req.body,
            params: req.params,
            query: req.query,
        };
    }
}

Controller with @ResponseBody(), @Param(), @Body(), and @Query()

import { Controller, Get, Request, Response } from 'typhoonts';

@Controller('/users')
export class UserController {
    @Put("/:id")
    @ResponseBody()
    update(
        @Param("id") id: string,
        @Body() reqBody: any,
        @Query("keyword") keyword: string
    ) {
        return {
            body: reqBody,
            params: {
                id,
            },
            query: {
                keyword,
            },
        };
    }
}

In this example, a GET request to /users/123 would respond with User ID is 123.

Middleware

Body Parser

import { bodyParser } from 'typhoonts';

// Use body parser middleware
server.use(bodyParser);

Cookie Parser

import { cookieParser } from 'typhoonts';

// Use cookie parser middleware
server.use(cookieParser);

Session

import { session } from 'typhoonts';

// Use session middleware
server.use(session({ secret: 'my_secret_key' }));

Contributing

Contributions are welcome! Please open an issue or submit a pull request.

License

This project is licensed under the MIT License.