npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

superagent-aws-signed-request

v1.0.5

Published

plugin for superagent to sign requests with aws signature v4

Downloads

2,095

Readme

superagent-aws-signed-request

Greenkeeper badge

Superagent plugin that intercepts and signs the request with AWS Signature V4

Usage

Params

  • service - { String, required } a string specifying the AWS service you wish to make a request to. Supported Services.
  • options - { Object, optional } config object that contains optional params that have defaults
    • key - { String } override for default of AWS_ACCESS_KEY_ID environment variable
    • secret - { String } override for default of AWS_SECRET_ACCESS_KEY environment variable
    • region - { String } override for default of AWS_REGION environment variable
    • sessionToken - { String } required if you are using temporary credentials from AWS STS

Supported Aws Services

To find the appropriate service name to use, a helpful resource is the Amazon Resource Names (ARNs) and AWS Service Namespaces page.

Note: Some services like API Gateway while having a namespace of apigateway, actually require you to pass execute-api if you are trying to make a request to the api hosted there. If you choose the wrong service name, an error should be returned with the service name you need, based on the service you are making a request to.

Example

const request = require('superagent');
const signRequest = require('superagent-aws-signed-request');

const awsService = 'execute-api'; // using api gateway as an example, look above for other services you can make requests to
return request
  .get(/* aws endpoint you wish to make a request to */)
  .use(signRequest(service, {
    key: 'AWS_ACCESS_KEY_ID', // uses env var by default
    secret: 'AWS_SECRET_ACCESS_KEY', // uses env var by default
    region: 'AWS_REGION', // uses env var by default
    sessionToken: 'sessionToken', // is needed if you are using temporary credentials from Amazon STS service
  }))
  .then( resp => console.log(resp));

Install

It's available on npm so you can simply install it with:

npm install --save superagent-aws-signed-request