egg-response

    1.8.1 • Public • Published

    egg-response

    English|中文

    NPM version build status Test coverage David deps Known Vulnerabilities npm download

    Dependency Description

    Dependent egg version

    Egg-response version egg 1.x
    1.x 😁
    0.x

    Installation

    $ npm i egg-response --save
    or
    $ yarn add egg-response

    Open the plugin

    // config/plugin.js
    exports.response = {
      enable: true,
      package: 'egg-response',
    };

    Where to use

    // {app_root}/app/controller/post.js
     
    ctx.successful(data[,options]);
     
    // or
     
    ctx.failed([options]);

    API

    ctx.successful(data[,options])

    Create a successful response

    Parameter

    • data - the data returned by the response
    • options (optional) -Object with the following optional attributes:
      • isData -boolean, whether to return data, the default value is true,If set to false, the returned json field data will be replaced by message
      • code -int, response status code, default value is 200
      • extra -Object, additional information

    Example

    ctx.successful([1,2,3],{
      extra: {
        xxx: 'Additional message'
      }
    });
    • Returns the result, will be in json format, as follows:
    {
      "success": true,
      "code": 200,
      "data": [1,2,3],
      "xxx": "Additional message"
    }

    ctx.failed([options])

    Create a failed response

    Parameter

    • options (optional) -Object with the following optional attributes:
      • message - error message, default value is 'Request error'
      • code - response status code, default value is 500
      • extra - append message

    Example

    ctx.failed({ message: 'There is no such category' });
    • Returns the result,will be in json format, as follows:
    {
      "code": 500,
      "success": false,
      "message": "There is no such category"
    }

    Outdated (v1.1.0)

    ctx.createSuccessResponse(data[,code])

    with

    ctx.createFailedResponse([message[,code]])

    Detailed configuration

    Go to config/config.default.js for detailed configuration item descriptions.

    Asking questions

    Please go to egg issues for asynchronous communication.

    License

    MIT

    Install

    npm i egg-response

    DownloadsWeekly Downloads

    42

    Version

    1.8.1

    License

    MIT

    Unpacked Size

    11.6 kB

    Total Files

    11

    Last publish

    Collaborators

    • iamljw