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

@orangejellyfish/serverless-toolkit

v2.2.0

Published

![Title Banner](https://banners.beyondco.de/Serverless%20Toolkit.png?theme=dark&packageManager=npm+install&packageName=%40orangejellyfish%2Fserverless-toolkit&pattern=signal&style=style_1&description=Opinionated+Toolkit+For+Serverless+Apps&md=1&showWaterm

Downloads

298

Readme

serverless-toolkit

Title Banner

A set of opinionated tools and utilities for the Serverless Framework, in particular for Node.js Lambda functions running in AWS.

Usage

Install the package from npm with npm i @orangejellyfish/serverless-toolkit.

Lambda function handlers

All of the handler factories are exported as named exports and expect a handler function. They cover a range of common methods by which AWS Lambda functions may be invoked and pull requests are welcomed for further methods not yet covered by this toolkit.

handleJSON

Creates a Lambda function handler that is expected to be invoked in response to an HTTP request via the AWS API Gateway with a Content-Type header with value application/json.

The handler will be invoked with the parsed JSON body of the request and the raw API Gateway event object which is useful if you need to access other parts of the request in your handler.

import { handleJSON } from '@orangejellyfish/serverless-toolkit';

export default handleJSON(async (body, event) => {
  return {
    statusCode: 200,
  };
});

handleURLEncoding

Creates a Lambda function handler that is expected to be invoked in response to an HTTP request via the AWS API Gateway with a Content-Type header with value application/x-www-form-urlencoded.

The handler will be invoked with the parsed JSON body of the request and the raw API Gateway event object which is useful if you need to access other parts of the request in your handler.

import { handleURLEnconding } from '@orangejellyfish/serverless-toolkit';

export default handleURLEnconding(async (body, event) => {
  return {
    statusCode: 200,
  };
});

handleSNS

Creates a Lambda function handler that is expected to be invoked in response to a message made up of a JSON string being published to an AWS SNS topic.

The handler will be invoked with the parsed JSON body of the message.

import { handleSNS } from '@orangejellyfish/serverless-toolkit';

export default handleSNS(async (message, event) => {
  return null;
});

handleSNSFIFO

Creates a Lambda function handler that is expected to be invoked in response to a message being published to an AWS SNS FIFO topic. Since the only valid destination for messages on FIFO topics is an SQS FIFO queue this utility is expected to be used in conjunction with handleSQSPartialBatchFailure.

The handler will be invoked with the parsed JSON body of the message and the original events from SNS and SQS. The return value of the handler is ignored and the original SQS event object is passed back to the SQS partial batch failure handler.

import { handleSNSFIFO, handleSQSPartialBatchFailure } from '@orangejellyfish/serverless-toolkit';

export default handleSQSPartialBatchFailure(
  handleSNSFIFO(async (message, snsRecord, sqsRecord) => {
    return null;
  }),
  {
    queueURL: process.env.QUEUE_URL,
  },
);

handleSQSPartialBatchFailure

Creates a Lambda function handler that is expected to be invoked in response to a batch of messages on an SQS queue. Automatically removes successfully handled messages from the queue and throws any failures to ensure those messages are returned to the queue for later processing.

import { handleSQSPartialBatchFailure } from '@orangejellyfish/serverless-toolkit';

export default handleSQSPartialBatchFailure(async (message, sqsRecord) => {
  return null;
}, {
  queueURL: process.env.QUEUE_URL,
});

Lambda function response utilities

responseJSON

Produce an object of the format expected by a Lambda function that has been invoked in response to an HTTP request via API Gateway. Intended to work hand in hand with the handleJSON handler factory.

import { handleJSON, responseJSON } from '@orangejellyfish/serverless-toolkit';

export default handleJSON(async (body, event) => {
  return responseJSON(200, {
    hello: 'world',
  });
});