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

aws-gateway-api

v0.1.2

Published

A simple client the wraps the AWS Gateway API

Downloads

11

Readme

AWS Gateway API Client

You might ask why does this exist? Well there are a few other tools out there but most of them seem to not be up to date or come with some huge library like JAWS or Fluct. I just wanted a simple wrapper that I could use to programmability setup an API however I want. Enjoy!

Usage

The basic usage is just new up a new object passing settings and you will be able to get all info from that object with functions and callbacks.

npm install aws-gateway-api --save
var Gateway = require('aws-gateway-api');

var api = new Gateway({
  accessKeyId: [AWS users access key (Defaults to environment variable AWS_ACCESS_KEY_ID)],
  secretAccessKey: [AWS users secret access key (Defaults to environment variable AWS_SECRET_ACCESS_KEY)]
  region: [AWS region (Defaults to environment variable AWS_REGION)]
});

//Now you can get a restApi like so
api.getRestApi('3ffr3r3r', function(err, restApi) {
  if (err) {
    console.log(err);
  } else {
    console.log(restApi.name);
  }
});

I am working on the documentation for all the methods now.

Testing

If you want to run the tests on this project you will need to set 4 environment variables so pointing to AWS. The user who has access key you use must have full permissions to the AWS Gateway API but will clean up everything after running. I tend to add these to my .bashrc or .bash_profile file.

export AWS_ACCESS_KEY_ID="[YOUR ACCESS KEY ID]"
export AWS_SECRET_ACCESS_KEY="[YOUR ACCESS KEY SECRET]"
export AWS_REGION="[THE AWS REGION]"
export AWS_ACCOUNT_ID="[YOUR AWS ACCOUNT ID]"