Giter Club home page Giter Club logo

koa-response-middleware's Introduction

koa-response-middleware

koa response middleware for [email protected], including http status, response header, response body, error handler.

Installation

npm install koa-response-middleware -S

Usage

import * as Koa from 'koa';
import * as handleResponse from 'koa-response-middleware';

const app = new Koa();
app.use(handleResponse({
  headers: {
    server: 'xxx.com',
  },
  successInfo: {
    version: '1.0.0',
  },
  errorMessage: 'please contact xxx<[email protected]>',
  isOptions: {
    isStatus: true,
    isStamp: true,
  },
}));

app.use((ctx) => {
  ctx.body = {
    name: 'handle response',
  };
});

API

  • headers {Object} set http response headers.
  • successInfo {Object} wrap http response success body
  • errorMessage {String} http response error message
  • isOptions {Object} wrap http response status code and stamp into response body
  • isOptions.isStatusCode {Boolean} wrap http response status code into response body
  • isOptions.isStamp {Boolean} wrap http response stamp into response body

License

MIT

koa-response-middleware's People

Contributors

soonfy avatar

Watchers

 avatar

Forkers

metaory luankefei

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.