To help you get started, we've collected the most common ways that lambda-local is being used within popular public projects.

rmtuckerphx / alexa-skill-serverless-starter-template / test / debugger / main.js View on Github

var lambdalocal = require("lambda-local");
var winston = require("winston");
var lambda = require('../../src/main.js');

var functionName = "handler";
var timeoutMs = 3000;
var region = config.region;
var profileName = config.awsProfile;

winston.level = "error";
lambdalocal.setLogger(winston);



lambdalocal.execute({
    event: event,
    lambdaFunc: lambda,
    lambdaHandler: functionName,
    region: region,
    profileName : profileName,
    callbackWaitsForEmptyEventLoop: false,
    timeoutMs: timeoutMs,
    callback: function (_err, _done) {
        done = _done;
        err = _err;

        if (done) {
            console.log('context.done');
            console.log(done);
        }

View more ways to use lambda-local

Lambda-local

Lambda-local lets you test NodeJS Amazon Lambda functions on your local machine, by providing a simplistic API and command-line tool.

It does not aim to be perfectly feature proof as projects like serverless-offline or docker-lambda, but rather to remain very light (it still provides a fully built Context, handles all of its parameters and functions, and everything is customizable easily).

The main target are unit tests and running lambda functions locally.

Install

npm install -g lambda-local

Build

make build

Or

npm install
npm install --only=dev
npm run build

Usage

• As an API: You can also use Lambda local directly in a script. For instance, it is interesting in a [MochaJS][1] test suite in order to get test coverage.
• As a command line tool: You can use Lambda-local as a command line tool.

If you're unsure about some definitions, see Definitions for terminology.

About: API

LambdaLocal

API accessible with:

const lambdaLocal = require("lambda-local");

Or on TypeScript (supported on 1.7.0+):

import lambdaLocal = require("lambda-local");

lambdaLocal.execute(options)

Executes a lambda given the options object, which is a dictionary where the keys may be:

lambdaLocal.setLogger(logger)

lambdaLocal.getLogger()

Those functions allow to access the winston logger used by lambda-local.

API examples

A lot of examples, especially used among Mocha, may be found in the test files over: here

Basic usage: Using Promises

const lambdaLocal = require('lambda-local');

var jsonPayload = {
    'key': 1,
    'another_key': "Some text"
}

lambdaLocal.execute({
    event: jsonPayload,
    lambdaPath: path.join(__dirname, 'path_to_index.js'),
    profilePath: '~/.aws/credentials',
    profileName: 'default',
    timeoutMs: 3000
}).then(function(done) {
    console.log(done);
}).catch(function(err) {
    console.log(err);
});

Basic usage: using callbacks

const lambdaLocal = require('lambda-local');

var jsonPayload = {
    'key': 1,
    'another_key': "Some text"
}

lambdaLocal.execute({
    event: jsonPayload,
    lambdaPath: path.join(__dirname, 'path_to_index.js'),
    profilePath: '~/.aws/credentials',
    profileName: 'default',
    timeoutMs: 3000,
    callback: function(err, data) {
        if (err) {
            console.log(err);
        } else {
            console.log(data);
        }
    },
    clientContext: JSON.stringify({clientId: 'xxxx'})
});

About: CLI

Available Arguments

• -l, --lambda-path (required) Specify Lambda function file name.
• -e, --event-path (required --watch is not in use) Specify event data file name.
• -h, --handler (optional) Lambda function handler name. Default is "handler".
• -t, --timeout (optional) Seconds until lambda function timeout. Default is 3 seconds.
• --esm (optional) Load lambda function as ECMAScript module.
• -r, --region (optional) Sets the AWS region, defaults to us-east-1.
• -P, --profile-path (optional) Read the specified AWS credentials file.
• -p, --profile (optional) Use with -P: Read the AWS profile of the file.
• -E, --environment (optional) Set extra environment variables for the lambda
• --wait-empty-event-loop (optional) Sets callbackWaitsForEmptyEventLoop=True => will wait for an empty loop before returning. This is false by default because our implementation isn't perfect and only "emulates" it.
• --envdestroy (optional) Destroy added environment on closing. Defaults to false
• -v, --verboselevel <3/2/1/0> (optional) Default 3. Level 2 dismiss handler() text, level 1 dismiss lambda-local text and level 0 dismiss also the result.
• `--envfile