https://github.com/backrunner/response-wrap

Simple response wrapper classes for Node.js servers
https://github.com/backrunner/response-wrap

Last synced: 2 months ago
JSON representation

Simple response wrapper classes for Node.js servers

• Host: GitHub
• URL: https://github.com/backrunner/response-wrap
• Owner: backrunner
• License: mit
• Created: 2022-02-20T12:37:10.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2023-11-27T17:36:16.000Z (over 2 years ago)
• Last Synced: 2026-03-19T09:40:46.340Z (3 months ago)
• Language: TypeScript
• Size: 51.8 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# response-wrap

Simple response wrapper classes for Node.js servers.

This package was created by [create-a-typescript-lib](https://github.com/backrunner/create-a-typescript-lib).

## Usage

Step 1: Install this package

```bash

npm install response-wrap -S

```

Step 2: Import and use it

```ts

import Koa from 'koa';

import KoaRouter from '@koa/router';

import { Response, SuccessResponse, ErrorResponse } from 'response-wrap';

interface ResponsePayload {

  token: string;

}

const app = new Koa();

const router = new Router();

router.get('/res', (ctx, next) => {

  ctx.body = new Response(

    {

      token: 'abc123',

    },

    0,

    'success',

  );

});

router.get('/error', (ctx, next) => {

  ctx.body = new ErrorResponse(-1, 'internal server error');

});

router.get('/successRes', (ctx, next) => {

  ctx.body = new SuccessResponse({

    token: 'abc123',

  });

});

```

## License

MIT