Giter Club home page Giter Club logo

agrios's Introduction

CircleCI codecov

๐Ÿ“ฆ๐Ÿ‘ Package your agreed server as axios adapter

Agrios packages your agree file into axios adapter. If you set it as the adapter of axios, then it gets responses from the agrees of your agreed files. See below for details.

Install

npm install --save-dev agrios

Usage

First create adapter:

const agrees = require('./path/to/agreed-file')
const agrios = require('agrios')

const agreedAdapter = agrios(agrees)

Then set it to your axios:

const axios = require('axios')

axios.default.adapter = agreedAdapter

Then your axios calls get responses from the agreed files.

axios.get('path/to/agreed-endpoint', { params: { some_key: 'some_value' } })

This doesn't make an acutual API request, but does get the response from the agreed files.

API

const agrios = require('agrios')

agrios(agrees)

  • @param {Object[]} agrees The list of agree objects

Creates the axios adapter from the agreed definition array.

NOTE: Each item in agrees have to be an object. Unlike agreed-server, the string item (path of the agree file) is not supported.

If you have agreed root file like the below:

module.exports = [
  './path/to/agree/foo.js',
  './path/to/agree/bar.js',
  './path/to/agree/baz.js',
  './path/to/agree/qux.js'
]

You need to rewrite it to:

module.exports = [
  require('./path/to/agree/foo.js'),
  require('./path/to/agree/bar.js'),
  require('./path/to/agree/baz.js'),
  require('./path/to/agree/qux.js')
]

License

MIT

agrios's People

Contributors

kt3k avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

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.