lambda-http-helper v0.0.3

📦 lambda-http-helper

A tiny helper that provides a better api for HTTP based Lambda function (AWS)

Want to help ⁉️

This is a small project, it has already helped me to write cleaner code for my ƛ lambda function and i think it can help the community.

If you want to help me with code, test, documentation or if you have any suggestions. Please contact me or feel free to send me a pull request.

Installation

To start using it, just type this command in your console :

npm install lambda-http-helper

Basic use

This is the main way of using this package.

const lambdaHttp = require('lambda-http-helper')

module.exports.yourLambdaFunction = lambdaHttp((req, res) => {

  const {body} = req

  res({
    type: 'json',
    cors: true,
    status: 200
  })({
    hello: body.world
  })

})

Alternative use

You can also use it in a more "functional" way.

const {req, res} = require('lambda-http-helper')

module.exports.yourLambdaFunction = (event, context, callback) => {

  const {body} = req(event)

  res({
    type: 'json',
    cors: true,
    status: 200
  }, callback))({
    hello: body.world
  })

}

API

Lambda-http-helper provide two main variables to interact with the API Gateway methods and variables

The req object

This request object is a plain javascript object. It gives you access to Body, Param and Query data.

const {body, params, query} = req

The res function

This is the Response function,

• It helps you to "prepare" your response.
• It returns a function that takes the actual data as parameters.

JSON response example

// return some json with status 200
const successResponse = res({
  status: 200, // default value
  type: 'json' // default value
})

// calling the success method to send data back to the Client
successResponse({
  hello: 'world'
})

HTML response example

// return some html with status 404
const notFound = res({
  status: 404,
  type: 'html'
})

// calling the success method to send data back to the Client
const template = getNotFoundHTMLTemplate()
notFound(template)

⚠️ Disclaimer ⚠️

Lambda-http-helper is a tiny helper that i wrote on a long and boring flight 🛩, there is no test yet, be careful.