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

lib-lambda-wrapper

v2.1.1

Published

Common utilities for wrapping aws lambda api gateway endpoints

Downloads

1

Readme

Downloads Version License

@teleology/lambda-api

Common utilities for wrapping aws lambda api gateway endpoints

Installation

yarn add @teleology/lambda-api
# or
npm i --save @teleology/lambda-api

Documentation

Wrapper

The wrapper function is a HOC, and will extract data from the incoming api gateway event. QueryStringParameters, pathParameters, and body data will automatically be collected and exposed in the data object. Header keys will be lowercased.

import { wrapper } from '@teleology/lambda-api';

const handler = async ({ headers, data }) => {
  // Some implementation
};

export default wrapper(handler);

ApiError

ApiError is inherited from the base Error instance, with some extra features. It defaults with an empty message and a 500 code to reflect a respone error. Additional properties can be added to the error upon creation.

import { ApiError, wrapper } from '@teleology/lambda-api';

const handler = async ({ headers, data }) => {
  if (!data.username) {
    throw new ApiError('Bad Request', {
      code: 400,

      // additional properties
      description: 'Missing username property',
    })
  }

  // ...
};

export default wrapper(handler);

request

Consumes an aws api gateway event, enhancing and parsing inputs.

* Body data will be parsed in the following order:

  1. Buffer
  2. JSON.parse
  3. querystring.parse
import { request } from '@teleology/lambda-api';

const sampleEvent = {
  headers: {
    'Content-Type': 'application/json',
    'Fake-Header': 'test',
  },
  pathParameters: {
    username: 'foo',
  },
  body: '',
};

console.log(request(sampleEvent));

Output:

{
  headers: { 'content-type': 'application/json', 'fake-header': 'test' },
  data: { username: 'foo' }
}

response

Sanitizes response data into a format api gateway understands.

import { response } from '@teleology/lambda-api';

const sampleResponse = {
  headers: {
    'Content-Type': 'application/json',
    'Fake-Header': 'test',
  },
  body: {
    foo: 'bar',
  },
};

console.log(response(sampleResponse));

Output:

{
  statusCode: '204',
  body: '{"foo":"bar"}',
  headers: {
    'Access-Control-Allow-Origin': '*',
    'Access-Control-Allow-Credentials': true,
    'Content-Type': 'application/json',
    'Fake-Header': 'test'
  }
}

Changelog

0.1.2

  • Adding error serialization for clearer reading in wrapper

0.1.1

  • Allow normal body and header response items, but default to entire response being the body

0.1.0

  • Fixed body parsing error where strings were being spread operated
  • Added documentation
  • Added full test coverage

0.0.1

  • Initial upload