Coder Social home page Coder Social logo

lambda-chain's Introduction

Lambda Chain

Promisify lambda handlers and allow before and after function chains

Build Status Coverage Status npm version GitHub license

Details

This package makes it possible to chain aws lambda functions together by registering handlers and hooks (also just handlers) which can occur before or after a given handler, similar to middleware.

The package also promisifies all handlers so that you don't worry about the callback, instead returning or throwing errors appropriately. This is handy if you are maybe using babel with async / await and want to have it work straight away.

Here is a short full example in some babel-ified code

import lambda from 'lambda-chain';

// Imaginary async stuffs
const handler = async (event, context) => 'handled...';

// Register the handler, this sets up the promise wrap
// and ability to add before or after hooks here or by name
lambda.register(handler);

// Unwrap the handlers as an export -> { handler: Function }
module.exports = lambda.exports();

Note: When using register, function names are detected. Different node versions handle function naming differently. You need to consider this when passing function handlers (not hooks).

Install

npm install --save lambda-chain

Usage

register(handler, [hooks])

Registers a handler and optionally the given hooks.

handler: Function|Object|Handler

hooks: Object - e.g. { before: Function|Array<Function>, after: Function|Array<Function> }

Example

const lambda = require('lambda-chain');
const handlers = require('./cool/handlers');
const parser = require('./magical/parser');

lambda.register(handlers, {
  before: [parser.fromJSON],
  after: [parser.toJSON]
});

before(handler, [hooks])

Registers a hook or array of hooks to run before the given handler.

handler: Function|Handler|String - The handler, or the name of a handler

hooks: Function|Array - The function or functions to execute before the given handler

Example

const lambda = require('lambda-chain');
const handlers = require('./cool/handlers');
const parser = require('./magical/parser');

lambda.register(handlers);
lambda.before(handler.doStuff, parser.transformThing);

after(handler, [hooks])

Registers a hook or array of hooks to run after the given handler.

handler: Function|Handler|String - The handler, or the name of a handler

hooks: Function|Array - The function or functions to execute after the given handler

Example

const lambda = require('lambda-chain');
const handlers = require('./cool/handlers');
const {cors} = require('./magical/httpstuffs');

lambda.register(handlers);
lambda.after(handler.doStuff, cors);

Other

There are other ways to use the package but this documentation requires an update. Try taking a look in the tests. For example you can pass an instance of a Handler class to the register, such as the HttpEventHandler class which just calls the relevant http method.

lambda-chain's People

Contributors

lteacher avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.