https://github.com/segevfiner/axios-light-my-request-adapter

Axios adapter for Light my Request
https://github.com/segevfiner/axios-light-my-request-adapter

adapter axios axios-adapter fake http inject light-my-request request server

Last synced: about 2 months ago
JSON representation

Axios adapter for Light my Request

• Host: GitHub
• URL: https://github.com/segevfiner/axios-light-my-request-adapter
• Owner: segevfiner
• License: mit
• Created: 2022-07-10T19:04:02.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-13T21:53:23.000Z (4 months ago)
• Last Synced: 2024-10-14T04:36:11.171Z (2 months ago)
• Topics: adapter, axios, axios-adapter, fake, http, inject, light-my-request, request, server
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/axios-light-my-request-adapter
• Size: 425 KB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# axios Light my Request Adapter

[![CI](https://github.com/segevfiner/axios-light-my-request-adapter/actions/workflows/ci.yml/badge.svg)](https://github.com/segevfiner/axios-light-my-request-adapter/actions/workflows/ci.yml)

[![Docs](https://github.com/segevfiner/axios-light-my-request-adapter/actions/workflows/docs.yml/badge.svg)](https://segevfiner.github.io/axios-light-my-request-adapter/)

This can be used to wire an Axios based client to a server during testing using Light my Request. Requires `axios@^1`.

[Documentation](https://segevfiner.github.io/axios-light-my-request-adapter/)

## Getting Started

```js

const axios = require("axios");

const {

  createLightMyRequestAdapter,

} = require("axios-light-my-request-adapter");

function dispatch(req, res) {

  res.writeHead(200, { "Content-Type": "application/json" });

  res.end(JSON.stringify({ data: "Hello World!" }));

}

const instance = axios.create({

  baseURL: "http://localhost/",

  adapter: createLightMyRequestAdapter(dispatch),

});

(async function () {

  const res = await instance.get("/");

  console.log(res);

})();

```

Or with [Fastify](https://www.fastify.io/):

```js

const axios = require("axios");

const fastify = require("fastify");

const {

  createLightMyRequestAdapterFromFastify,

} = require("axios-light-my-request-adapter");

const app = fastify();

app.get("/", async () => {

  return { data: "Hello World!" };

});

const instance = axios.create({

  baseURL: "http://localhost/",

  adapter: createLightMyRequestAdapterFromFastify(app),

});

(async function () {

  const res = await instance.get("/");

  console.log(res);

})();

```

## Caveats

- `maxRedirects` is not supported https://github.com/fastify/light-my-request/issues/209, and will throw.

- `socketPath` and `proxy` are not supported and will throw.

- `httpAgent` & `httpsAgent` are ignored.

## License

MIT.

Some code was taken from [axios](https://github.com/axios/axios), see [NOTICE](NOTICE)