0.0.1 • Published 4 years ago

egg-got v0.0.1

Weekly downloads
2
License
MIT
Repository
github
Last release
4 years ago

egg-got

NPM version

Important:

still in develop, do not use in production.

HTTP request library got plugin for eggjs.

Install

$ npm i egg-got

Usage

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

Configuration

// {app_root}/config/config.default.js
exports.got = {
  // ...
};

If you want to save got log, please define a custom logger named gotLogger, this name you can rename in got.logger.name.

// custom logger
exports.customLogger = {
  gotLogger: {
    // ...
  },
};

Options:

You can use got options in root property, but exclude hooks, you should got.extend it yourself.

logger.name

Type: string

The custom logger name.

logger.formatter

Type: Function

See got hooks for more detail.

For example:

/**
 * @param {Object} data
 * @param {string} data.type
 * @param {Object} data.options
 * @param {Object} data.response
 * @param {Object} data.error
 * ...
 */
function formatter(data) {
  switch (data.type) {
    case 'init': {
      const { options } = data;
      // ...
    }
    case 'beforeRetry': {
      const { options, error, retryCount } = data;
      // ...
    }
    case 'beforeError':
    case 'beforeRequest':
    case 'afterResponse':
    case 'beforeRedirect':
  }
}

License

MIT