furudean/lambda-response-template

A tiny utility for creating AWS Lambda response objects

lambda-response-template

💬 A tiny utility for creating AWS Lambda response objects.

This package provides an easy way for you generate templates for your responses. Increase readability and make your output more consistent across your Lambda application.

Install

npm install lambda-response-template

Features

• Templating
  • Create re-usable templates for your responses.
• Transforming
  • Transform your response body before returning it, removing the need to stringify your JSON responses.
• Fully TypeScript supported

Why

When developing large applications you often work across multiple repositories. I found myself following the same pattern of creating a factory in each repository every time I wanted set standards for a lambda's output. When you also have to add tests for this boilerplate it can quickly get annoying - this package aims to solve this problem by creating a first class, best version of this generic method.

Usage

Set up lambda-response-template with your defaults:

import { ResponseTemplate } from 'lambda-response-template';

const reply = new ResponseTemplate({
  headers: {
    'x-powered-by': 'nodejs',
  }
});

And then use inside your function:

async function handler(event, context) {
  return reply.make(200, body, options);
}

Your response will be made from the template, inheriting any options you set.

Tips

Shortcut for Content-Type header

const a = reply.make(200, body, {
  headers: { 'content-type': 'text/plain' }
});

// can be written as

const b = reply.make(200, body, 'text/plain');

Automatically stringify responses

const reply = new ResponseTemplate({
  transform: (value) => JSON.stringify(value)
})

const response = reply.make(400, {
  theTruth: 'Pizza cutters are a lie!'
});

lambda-response-template's Issues

An in-range update of @types/node is breaking the build 🚨

The devDependency @types/node was updated from 12.12.1 to 12.12.2.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

@types/node is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details

• ✅ ci/inspecode/push: 1 issue detected. (Details).
• ❌ codecov/project: 89.47% (-7.9%) compared to 54a023a (Details).
• ✅ codecov/patch: Coverage not affected when comparing 54a023a...1d6ed75 (Details).
• ❌ Travis CI - Branch: The build errored.

---

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

---

Your Greenkeeper Bot 🌴

An in-range update of ts-node is breaking the build 🚨

The devDependency ts-node was updated from 8.6.1 to 8.6.2.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

ts-node is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details

• ✅ ci/inspecode/push: 1 issue detected. (Details).
• ❌ Travis CI - Branch: The build errored.

---

Release Notes for FIx `yn` Dependency

Fixed

• Downgrade yn due to node engine (#942)

Commits

The new version differs by 3 commits.

• 8ac4be5 8.6.2
• 8db216c Downgrade yn due to node engine (#942)
• b90754e Merge process.env in tests for CI

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

---

Your Greenkeeper Bot 🌴