# @raydeck/serverless-lambda-builder

> Build lambda definitiosn for serverless

Latest version **2.5.0** (published 2021-03-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install @raydeck/serverless-lambda-builder
pnpm add @raydeck/serverless-lambda-builder
yarn add @raydeck/serverless-lambda-builder
bun add @raydeck/serverless-lambda-builder
```

Provides the command `serverless-lambda-builder`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.5.0 |
| Published | 2021-03-16 |
| First published | 2020-08-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 63 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Ray Deck |
| Maintainers | raydeck |

## Links

- npm: https://www.npmjs.com/package/@raydeck/serverless-lambda-builder
- Repository: https://github.com/rhdeck/serverless-lambda-builder
- Homepage: https://github.com/rhdeck/serverless-lambda-builder#readme
- Issues: https://github.com/rhdeck/serverless-lambda-builder/issues
- npm.io page: https://npm.io/package/@raydeck/serverless-lambda-builder

## Dependencies (7)

- [yaml](https://npm.io/package/yaml.md) ^1.10.0
- [tslint](https://npm.io/package/tslint.md) ^6.1.3
- [mustache](https://npm.io/package/mustache.md) ^4.0.1
- [prettier](https://npm.io/package/prettier.md) ^2.0.5
- [commander](https://npm.io/package/commander.md) ^6.0.0
- [@types/prettier](https://npm.io/package/@types/prettier.md) ^2.0.2
- [install-peers-cli](https://npm.io/package/install-peers-cli.md) ^2.2.0

## Recent versions

- 2.5.0 (latest) — 2021-03-16
- 2.4.0 — 2021-03-03
- 2.3.0 — 2021-01-15
- 2.2.2 — 2020-12-06
- 2.2.1 — 2020-12-05
- 2.2.0 — 2020-09-15
- 2.1.0 — 2020-09-11
- 2.0.3 — 2020-08-17
- 2.0.2 — 2020-08-17
- 2.0.1 — 2020-08-17
- 2.0.0 — 2020-08-14
- 1.0.1 — 2020-08-10
- 1.0.0 — 2020-08-10

## README

<a name="__climd"></a>

# Usage
```bash
npx @raydeck/serverless-lambda-builder [options] [command]
```
# Options
* -w --workingpath \<`path`> Working directory for project (default: .
# Commands
## serverless
Update serverless.yml with functions
### Usage
```bash
npx @raydeck/serverless-lambda-builder serverless [options]
```
### Options
* -y --yamlfile Path to serverless.yml file 
* -h --handler-file File containing getLambdas export 
* -l --lambdas-export Name of the lambdas export (result of getLambdas) 

<a name="_librarymd"></a>

[@raydeck/serverless-lambda-builder - v2.5.0](README.md)

# @raydeck/serverless-lambda-builder - v2.5.0

## Index

### Interfaces

* [LambdaArgs](#interfaceslambdaargsmd)
* [LambdaOptions](#interfaceslambdaoptionsmd)
* [LambdaOutput](#interfaceslambdaoutputmd)

### Type aliases

* [CognitoTriggerType](#cognitotriggertype)

### Variables

* [_defaults](#let-_defaults)
* [_wrapper](#let-_wrapper)

### Functions

* [buildServerlessFunctionsObj](#buildserverlessfunctionsobj)
* [getLambdaExports](#getlambdaexports)
* [httpSuccess](#httpsuccess)
* [makeAPIGatewayLambda](#makeapigatewaylambda)
* [makeCognitoLambda](#makecognitolambda)
* [makeDDBLambda](#makeddblambda)
* [makeEventBridgeLambda](#makeeventbridgelambda)
* [makeLambda](#makelambda)
* [makeS3Lambda](#makes3lambda)
* [makeSQSLambda](#makesqslambda)
* [sendHttpResult](#sendhttpresult)
* [setDefaults](#setdefaults)
* [setWrapper](#setwrapper)

## Type aliases

###  CognitoTriggerType

Ƭ **CognitoTriggerType**: *"CreateAuthChallenge" | "CustomMessage" | "DefineAuthChallenge" | "PostAuthentication" | "PostConfirmation" | "PreAuthentication" | "PreSignUp" | "TokenGeneration" | "UserMigration" | "VerifyAuthChallengeResponse"*

*Defined in [src/index.ts:106](https://github.com/rhdeck/serverless-lambda-builder/blob/82c71dd/src/index.ts#L106)*

## Variables

### `Let` _defaults

• **_defaults**: *[LambdaArgs](#interfaceslambdaargsmd)*

*Defined in [src/index.ts:34](https://github.com/rhdeck/serverless-lambda-builder/blob/82c71dd/src/index.ts#L34)*

___

### `Let` _wrapper

• **_wrapper**: *function*

*Defined in [src/index.ts:30](https://github.com/rhdeck/serverless-lambda-builder/blob/82c71dd/src/index.ts#L30)*

#### Type declaration:

▸ (...`args`: any[]): *any*

**Parameters:**

Name | Type |
------ | ------ |
`...args` | any[] |

## Functions

###  buildServerlessFunctionsObj

▸ **buildServerlessFunctionsObj**(`exportsObj`: object): *object*

*Defined in [src/index.ts:150](https://github.com/rhdeck/serverless-lambda-builder/blob/82c71dd/src/index.ts#L150)*

**Parameters:**

Name | Type |
------ | ------ |
`exportsObj` | object |

**Returns:** *object*

* \[ **key**: *string*\]: any

___

###  getLambdaExports

▸ **getLambdaExports**(`exports`: object): *[string, [LambdaOutput](#interfaceslambdaoutputmd)][]*

*Defined in [src/index.ts:132](https://github.com/rhdeck/serverless-lambda-builder/blob/82c71dd/src/index.ts#L132)*

**Parameters:**

Name | Type |
------ | ------ |
`exports` | object |

**Returns:** *[string, [LambdaOutput](#interfaceslambdaoutputmd)][]*

___

###  httpSuccess

▸ **httpSuccess**(`body`: any): *object*

*Defined in [src/index.ts:314](https://github.com/rhdeck/serverless-lambda-builder/blob/82c71dd/src/index.ts#L314)*

**Parameters:**

Name | Type |
------ | ------ |
`body` | any |

**Returns:** *object*

* **body**: *string*

* **statusCode**: *number*

* ### **headers**: *object*

  * **Access-Control-Allow-Credentials**: *boolean* = true

  * **Access-Control-Allow-Headers**: *string* = "Content-Type,X-Amz-Date,Authorization,X-Api-Key,X-Amz-Security-Token"

  * **Access-Control-Allow-Methods**: *string* = "OPTIONS,POST, GET"

  * **Access-Control-Allow-Origin**: *string* = "*"

  * **Content-Type**: *string* = "application/json"

  * **X-Requested-With**: *string* = "*"

___

###  makeAPIGatewayLambda

▸ **makeAPIGatewayLambda**(`args`: object & [LambdaOptions](#interfaceslambdaoptionsmd)): *function & function & object*

*Defined in [src/index.ts:54](https://github.com/rhdeck/serverless-lambda-builder/blob/82c71dd/src/index.ts#L54)*

**Parameters:**

Name | Type |
------ | ------ |
`args` | object & [LambdaOptions](#interfaceslambdaoptionsmd) |

**Returns:** *function & function & object*

___

###  makeCognitoLambda

▸ **makeCognitoLambda**‹**TEvent**, **TResult**›(`args`: object): *function & object*

*Defined in [src/index.ts:117](https://github.com/rhdeck/serverless-lambda-builder/blob/82c71dd/src/index.ts#L117)*

**Type parameters:**

▪ **TEvent**

▪ **TResult**

**Parameters:**

▪ **args**: *object*

Name | Type |
------ | ------ |
`func` | Handler‹TEvent, TResult› |
`pool` | string |
`triggerOrTriggers` | [CognitoTriggerType](#cognitotriggertype) &#124; [CognitoTriggerType](#cognitotriggertype)[] |

**Returns:** *function & object*

___

###  makeDDBLambda

▸ **makeDDBLambda**(`args`: object & [LambdaOptions](#interfaceslambdaoptionsmd)): *function & function & object*

*Defined in [src/index.ts:75](https://github.com/rhdeck/serverless-lambda-builder/blob/82c71dd/src/index.ts#L75)*

**Parameters:**

Name | Type |
------ | ------ |
`args` | object & [LambdaOptions](#interfaceslambdaoptionsmd) |

**Returns:** *function & function & object*

___

###  makeEventBridgeLambda

▸ **makeEventBridgeLambda**‹**TDetail**›(`args`: object): *function & object*

*Defined in [src/index.ts:97](https://github.com/rhdeck/serverless-lambda-builder/blob/82c71dd/src/index.ts#L97)*

**Type parameters:**

▪ **TDetail**

**Parameters:**

▪ **args**: *object*

Name | Type |
------ | ------ |
`detail` | object |
`detailType` | string |
`func` | EventBridgeHandler‹string, TDetail, void› |
`source` | string |

**Returns:** *function & object*

___

###  makeLambda

▸ **makeLambda**(`args`: [LambdaOptions](#interfaceslambdaoptionsmd)): *function & object*

*Defined in [src/index.ts:38](https://github.com/rhdeck/serverless-lambda-builder/blob/82c71dd/src/index.ts#L38)*

**Parameters:**

Name | Type |
------ | ------ |
`args` | [LambdaOptions](#interfaceslambdaoptionsmd) |

**Returns:** *function & object*

___

###  makeS3Lambda

▸ **makeS3Lambda**(`args`: object & [LambdaOptions](#interfaceslambdaoptionsmd)): *function & function & object*

*Defined in [src/index.ts:42](https://github.com/rhdeck/serverless-lambda-builder/blob/82c71dd/src/index.ts#L42)*

**Parameters:**

Name | Type |
------ | ------ |
`args` | object & [LambdaOptions](#interfaceslambdaoptionsmd) |

**Returns:** *function & function & object*

___

###  makeSQSLambda

▸ **makeSQSLambda**(`args`: object & [LambdaOptions](#interfaceslambdaoptionsmd)): *function & function & object*

*Defined in [src/index.ts:88](https://github.com/rhdeck/serverless-lambda-builder/blob/82c71dd/src/index.ts#L88)*

**Parameters:**

Name | Type |
------ | ------ |
`args` | object & [LambdaOptions](#interfaceslambdaoptionsmd) |

**Returns:** *function & function & object*

___

###  sendHttpResult

▸ **sendHttpResult**(`statusCode`: number, `body`: string, `headers?`: undefined | object): *object*

*Defined in [src/index.ts:293](https://github.com/rhdeck/serverless-lambda-builder/blob/82c71dd/src/index.ts#L293)*

**Parameters:**

Name | Type |
------ | ------ |
`statusCode` | number |
`body` | string |
`headers?` | undefined &#124; object |

**Returns:** *object*

* **body**: *string*

* **statusCode**: *number*

* ### **headers**: *object*

  * **Access-Control-Allow-Credentials**: *boolean* = true

  * **Access-Control-Allow-Headers**: *string* = "Content-Type,X-Amz-Date,Authorization,X-Api-Key,X-Amz-Security-Token"

  * **Access-Control-Allow-Methods**: *string* = "OPTIONS,POST, GET"

  * **Access-Control-Allow-Origin**: *string* = "*"

  * **Content-Type**: *string* = "application/json"

  * **X-Requested-With**: *string* = "*"

___

###  setDefaults

▸ **setDefaults**(`defaults`: [LambdaArgs](#interfaceslambdaargsmd)): *void*

*Defined in [src/index.ts:35](https://github.com/rhdeck/serverless-lambda-builder/blob/82c71dd/src/index.ts#L35)*

**Parameters:**

Name | Type |
------ | ------ |
`defaults` | [LambdaArgs](#interfaceslambdaargsmd) |

**Returns:** *void*

___

###  setWrapper

▸ **setWrapper**(`wrapper`: typeof _wrapper): *void*

*Defined in [src/index.ts:31](https://github.com/rhdeck/serverless-lambda-builder/blob/82c71dd/src/index.ts#L31)*

**Parameters:**

Name | Type |
------ | ------ |
`wrapper` | typeof _wrapper |

**Returns:** *void*


<a name="interfaceslambdaargsmd"></a>

[@raydeck/serverless-lambda-builder - v2.5.0](../README.md) › [LambdaArgs](#interfaceslambdaargsmd)

# Interface: LambdaArgs

## Hierarchy

* **LambdaArgs**

  ↳ [LambdaOptions](#interfaceslambdaoptionsmd)

## Index

### Properties

* [description](#optional-description)
* [layers](#optional-layers)
* [memorySize](#optional-memorysize)
* [name](#optional-name)
* [reservedConcurrency](#optional-reservedconcurrency)
* [role](#optional-role)
* [runtime](#optional-runtime)
* [timeout](#optional-timeout)
* [tracing](#optional-tracing)
* [warmup](#optional-warmup)

## Properties

### `Optional` description

• **description**? : *undefined | string*

*Defined in [src/index.ts:19](https://github.com/rhdeck/serverless-lambda-builder/blob/82c71dd/src/index.ts#L19)*

___

### `Optional` layers

• **layers**? : *string[]*

*Defined in [src/index.ts:21](https://github.com/rhdeck/serverless-lambda-builder/blob/82c71dd/src/index.ts#L21)*

___

### `Optional` memorySize

• **memorySize**? : *undefined | number*

*Defined in [src/index.ts:20](https://github.com/rhdeck/serverless-lambda-builder/blob/82c71dd/src/index.ts#L20)*

___

### `Optional` name

• **name**? : *undefined | string*

*Defined in [src/index.ts:18](https://github.com/rhdeck/serverless-lambda-builder/blob/82c71dd/src/index.ts#L18)*

___

### `Optional` reservedConcurrency

• **reservedConcurrency**? : *undefined | number*

*Defined in [src/index.ts:16](https://github.com/rhdeck/serverless-lambda-builder/blob/82c71dd/src/index.ts#L16)*

___

### `Optional` role

• **role**? : *undefined | string*

*Defined in [src/index.ts:14](https://github.com/rhdeck/serverless-lambda-builder/blob/82c71dd/src/index.ts#L14)*

___

### `Optional` runtime

• **runtime**? : *"node10.x" | "node12.x"*

*Defined in [src/index.ts:17](https://github.com/rhdeck/serverless-lambda-builder/blob/82c71dd/src/index.ts#L17)*

___

### `Optional` timeout

• **timeout**? : *undefined | number*

*Defined in [src/index.ts:13](https://github.com/rhdeck/serverless-lambda-builder/blob/82c71dd/src/index.ts#L13)*

___

### `Optional` tracing

• **tracing**? : *undefined | false | true*

*Defined in [src/index.ts:15](https://github.com/rhdeck/serverless-lambda-builder/blob/82c71dd/src/index.ts#L15)*

___

### `Optional` warmup

• **warmup**? : *undefined | false | true*

*Defined in [src/index.ts:12](https://github.com/rhdeck/serverless-lambda-builder/blob/82c71dd/src/index.ts#L12)*


<a name="interfaceslambdaoptionsmd"></a>

[@raydeck/serverless-lambda-builder - v2.5.0](../README.md) › [LambdaOptions](#interfaceslambdaoptionsmd)

# Interface: LambdaOptions

## Hierarchy

* [LambdaArgs](#interfaceslambdaargsmd)

  ↳ **LambdaOptions**

  ↳ [LambdaOutput](#interfaceslambdaoutputmd)

## Index

### Properties

* [description](#optional-description)
* [func](#func)
* [layers](#optional-layers)
* [memorySize](#optional-memorysize)
* [name](#optional-name)
* [reservedConcurrency](#optional-reservedconcurrency)
* [role](#optional-role)
* [runtime](#optional-runtime)
* [timeout](#optional-timeout)
* [tracing](#optional-tracing)
* [warmup](#optional-warmup)

## Properties

### `Optional` description

• **description**? : *undefined | string*

*Inherited from [LambdaArgs](#interfaceslambdaargsmd).[description](#optional-description)*

*Defined in [src/index.ts:19](https://github.com/rhdeck/serverless-lambda-builder/blob/82c71dd/src/index.ts#L19)*

___

###  func

• **func**: *Handler‹any, any›*

*Defined in [src/index.ts:24](https://github.com/rhdeck/serverless-lambda-builder/blob/82c71dd/src/index.ts#L24)*

___

### `Optional` layers

• **layers**? : *string[]*

*Inherited from [LambdaArgs](#interfaceslambdaargsmd).[layers](#optional-layers)*

*Defined in [src/index.ts:21](https://github.com/rhdeck/serverless-lambda-builder/blob/82c71dd/src/index.ts#L21)*

___

### `Optional` memorySize

• **memorySize**? : *undefined | number*

*Inherited from [LambdaArgs](#interfaceslambdaargsmd).[memorySize](#optional-memorysize)*

*Defined in [src/index.ts:20](https://github.com/rhdeck/serverless-lambda-builder/blob/82c71dd/src/index.ts#L20)*

___

### `Optional` name

• **name**? : *undefined | string*

*Inherited from [LambdaArgs](#interfaceslambdaargsmd).[name](#optional-name)*

*Defined in [src/index.ts:18](https://github.com/rhdeck/serverless-lambda-builder/blob/82c71dd/src/index.ts#L18)*

___

### `Optional` reservedConcurrency

• **reservedConcurrency**? : *undefined | number*

*Inherited from [LambdaArgs](#interfaceslambdaargsmd).[reservedConcurrency](#optional-reservedconcurrency)*

*Defined in [src/index.ts:16](https://github.com/rhdeck/serverless-lambda-builder/blob/82c71dd/src/index.ts#L16)*

___

### `Optional` role

• **role**? : *undefined | string*

*Inherited from [LambdaArgs](#interfaceslambdaargsmd).[role](#optional-role)*

*Defined in [src/index.ts:14](https://github.com/rhdeck/serverless-lambda-builder/blob/82c71dd/src/index.ts#L14)*

___

### `Optional` runtime

• **runtime**? : *"node10.x" | "node12.x"*

*Inherited from [LambdaArgs](#interfaceslambdaargsmd).[runtime](#optional-runtime)*

*Defined in [src/index.ts:17](https://github.com/rhdeck/serverless-lambda-builder/blob/82c71dd/src/index.ts#L17)*

___

### `Optional` timeout

• **timeout**? : *undefined | number*

*Inherited from [LambdaArgs](#interfaceslambdaargsmd).[timeout](#optional-timeout)*

*Defined in [src/index.ts:13](https://github.com/rhdeck/serverless-lambda-builder/blob/82c71dd/src/index.ts#L13)*

___

### `Optional` tracing

• **tracing**? : *undefined | false | true*

*Inherited from [LambdaArgs](#interfaceslambdaargsmd).[tracing](#optional-tracing)*

*Defined in [src/index.ts:15](https://github.com/rhdeck/serverless-lambda-builder/blob/82c71dd/src/index.ts#L15)*

___

### `Optional` warmup

• **warmup**? : *undefined | false | true*

*Inherited from [LambdaArgs](#interfaceslambdaargsmd).[warmup](#optional-warmup)*

*Defined in [src/index.ts:12](https://github.com/rhdeck/serverless-lambda-builder/blob/82c71dd/src/index.ts#L12)*


<a name="interfaceslambdaoutputmd"></a>

[@raydeck/serverless-lambda-builder - v2.5.0](../README.md) › [LambdaOutput](#interfaceslambdaoutputmd)

# Interface: LambdaOutput

## Hierarchy

  ↳ [LambdaOptions](#interfaceslambdaoptionsmd)

  ↳ **LambdaOutput**

## Callable

▸ (): *Handler‹any, any›*

*Defined in [src/index.ts:26](https://github.com/rhdeck/serverless-lambda-builder/blob/82c71dd/src/index.ts#L26)*

**Returns:** *Handler‹any, any›*

## Index

### Properties

* [description](#optional-description)
* [func](#func)
* [lambdaType](#lambdatype)
* [layers](#optional-layers)
* [memorySize](#optional-memorysize)
* [name](#optional-name)
* [reservedConcurrency](#optional-reservedconcurrency)
* [role](#optional-role)
* [runtime](#optional-runtime)
* [timeout](#optional-timeout)
* [tracing](#optional-tracing)
* [warmup](#optional-warmup)

## Properties

### `Optional` description

• **description**? : *undefined | string*

*Inherited from [LambdaArgs](#interfaceslambdaargsmd).[description](#optional-description)*

*Defined in [src/index.ts:19](https://github.com/rhdeck/serverless-lambda-builder/blob/82c71dd/src/index.ts#L19)*

___

###  func

• **func**: *Handler‹any, any›*

*Inherited from [LambdaOptions](#interfaceslambdaoptionsmd).[func](#func)*

*Defined in [src/index.ts:24](https://github.com/rhdeck/serverless-lambda-builder/blob/82c71dd/src/index.ts#L24)*

___

###  lambdaType

• **lambdaType**: *string*

*Defined in [src/index.ts:28](https://github.com/rhdeck/serverless-lambda-builder/blob/82c71dd/src/index.ts#L28)*

___

### `Optional` layers

• **layers**? : *string[]*

*Inherited from [LambdaArgs](#interfaceslambdaargsmd).[layers](#optional-layers)*

*Defined in [src/index.ts:21](https://github.com/rhdeck/serverless-lambda-builder/blob/82c71dd/src/index.ts#L21)*

___

### `Optional` memorySize

• **memorySize**? : *undefined | number*

*Inherited from [LambdaArgs](#interfaceslambdaargsmd).[memorySize](#optional-memorysize)*

*Defined in [src/index.ts:20](https://github.com/rhdeck/serverless-lambda-builder/blob/82c71dd/src/index.ts#L20)*

___

### `Optional` name

• **name**? : *undefined | string*

*Inherited from [LambdaArgs](#interfaceslambdaargsmd).[name](#optional-name)*

*Defined in [src/index.ts:18](https://github.com/rhdeck/serverless-lambda-builder/blob/82c71dd/src/index.ts#L18)*

___

### `Optional` reservedConcurrency

• **reservedConcurrency**? : *undefined | number*

*Inherited from [LambdaArgs](#interfaceslambdaargsmd).[reservedConcurrency](#optional-reservedconcurrency)*

*Defined in [src/index.ts:16](https://github.com/rhdeck/serverless-lambda-builder/blob/82c71dd/src/index.ts#L16)*

___

### `Optional` role

• **role**? : *undefined | string*

*Inherited from [LambdaArgs](#interfaceslambdaargsmd).[role](#optional-role)*

*Defined in [src/index.ts:14](https://github.com/rhdeck/serverless-lambda-builder/blob/82c71dd/src/index.ts#L14)*

___

### `Optional` runtime

• **runtime**? : *"node10.x" | "node12.x"*

*Inherited from [LambdaArgs](#interfaceslambdaargsmd).[runtime](#optional-runtime)*

*Defined in [src/index.ts:17](https://github.com/rhdeck/serverless-lambda-builder/blob/82c71dd/src/index.ts#L17)*

___

### `Optional` timeout

• **timeout**? : *undefined | number*

*Inherited from [LambdaArgs](#interfaceslambdaargsmd).[timeout](#optional-timeout)*

*Defined in [src/index.ts:13](https://github.com/rhdeck/serverless-lambda-builder/blob/82c71dd/src/index.ts#L13)*

___

### `Optional` tracing

• **tracing**? : *undefined | false | true*

*Inherited from [LambdaArgs](#interfaceslambdaargsmd).[tracing](#optional-tracing)*

*Defined in [src/index.ts:15](https://github.com/rhdeck/serverless-lambda-builder/blob/82c71dd/src/index.ts#L15)*

___

### `Optional` warmup

• **warmup**? : *undefined | false | true*

*Inherited from [LambdaArgs](#interfaceslambdaargsmd).[warmup](#optional-warmup)*

*Defined in [src/index.ts:12](https://github.com/rhdeck/serverless-lambda-builder/blob/82c71dd/src/index.ts#L12)*

---
_Source: https://npm.io/package/@raydeck/serverless-lambda-builder · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._