lambda-wrap

LambdaWrap

---

API

Classes

LambdaWrap

Functions

error(message, code)

Return new error object.

LambdaWrap

Kind: global class

• LambdaWrap
  • new LambdaWrap([options])
  • ~wrap(fn) ⇒ function
    • .responseHandler
    • .errorResponseHandler
    • .logger
    • .before(fn)
    • .catch(fn)

new LambdaWrap([options])

LambdaWrap constructor. You can pass options to override or assign new attributes to event object. For example add custom headers:

const headers = {
  'X-Auth-Token': 'my-token'
};

const wrap = new LambdaWrap({ headers });

It returns an instance of LambdaWrap - wrap object. This object can be used for specifying additional properties:

wrap.responseHandler = customResponseFunction;

Finally, wrap object can be used as a function to wrap any generator function and thus create lambda handler:

const handler = wrap(customGeneratorFunction);

Returns: Object - - New instance of LambdaWrap.

Param	Type	Default	Description
[options]	Object	{}	Use to override or assign new attributes to event object. E.g. headers.

LambdaWrap~wrap(fn) ⇒ function

Kind: inner method of LambdaWrap Returns: function - - Lambda handler.

Param	Type	Description
fn	function	Function to be wrapped and used as a lambda handler.

• ~wrap(fn) ⇒ function
  • .responseHandler
  • .errorResponseHandler
  • .logger
  • .before(fn)
  • .catch(fn)

wrap.responseHandler

Override default response function

Kind: static property of wrap

wrap.errorResponseHandler

Override default error response function

Kind: static property of wrap

wrap.logger

Override default logger object - console. MUST implement log and error methods.

Kind: static property of wrap

wrap.before(fn)

Add new middleware.

Kind: static method of wrap

Param	Type	Description
fn	function	Middleware function.

wrap.catch(fn)

Add new catch.

Kind: static method of wrap

Param	Type	Description
fn	function	Catch function.

error(message, code)

Return new error object.

Kind: global function

Param	Type	Description
message	string	Error message.
code	integer	Error code.