JSPM

  • Created
  • Published
  • Downloads 235347
  • Score
    100M100P100Q175350F
  • License MIT

Axios request interceptor for signing requests with AWSv4

Package Exports

  • aws4-axios

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (aws4-axios) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

aws4-axios

npm version npm downloads circleci build

This is a request interceptor for the Axios HTTP request library to allow requests to be signed with an AWSv4 signature.

This may be useful for accessing AWS services protected with IAM auth such as an API Gateway.

Installation

yarn npm
yarn add aws4-axios npm install --save aws4-axios

Usage

To add an interceptor to the default Axios client:

import axios from "axios";
import { aws4Interceptor } from "aws4-axios";

const interceptor = aws4Interceptor({
  region: "eu-west-2",
  service: "execute-api"
});

axios.interceptors.request.use(interceptor);

// Requests made using Axios will now be signed
axios.get("https://example.com/foo").then(res => {
  // ...
});

Or you can add the interceptor to a specific instance of an Axios client:

import axios from "axios";
import { aws4Interceptor } from "aws4-axios";

const client = axios.create();

const interceptor = aws4Interceptor({
  region: "eu-west-2",
  service: "execute-api"
});

client.interceptors.request.use(interceptor);

// Requests made using Axios will now be signed
client.get("https://example.com/foo").then(res => {
  // ...
});