README
Usage
npx @raydeck/serverless-lambda-builder [options] [command]
Options
- -w --workingpath <
path
> Working directory for project (default: .
Commands
serverless
Update serverless.yml with functions
Usage
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)
@raydeck/serverless-lambda-builder - v2.5.0
@raydeck/serverless-lambda-builder - v2.5.0
Index
Interfaces
Type aliases
Variables
Functions
- buildServerlessFunctionsObj
- getLambdaExports
- httpSuccess
- makeAPIGatewayLambda
- makeCognitoLambda
- makeDDBLambda
- makeEventBridgeLambda
- makeLambda
- makeS3Lambda
- makeSQSLambda
- sendHttpResult
- setDefaults
- setWrapper
Type aliases
CognitoTriggerType
Ƭ CognitoTriggerType: "CreateAuthChallenge" | "CustomMessage" | "DefineAuthChallenge" | "PostAuthentication" | "PostConfirmation" | "PreAuthentication" | "PreSignUp" | "TokenGeneration" | "UserMigration" | "VerifyAuthChallengeResponse"
Defined in src/index.ts:106
Variables
_defaults Let
• _defaults: LambdaArgs
Defined in src/index.ts:34
_wrapper Let
• _wrapper: function
Defined in src/index.ts:30
Type declaration:
▸ (...args
: any[]): any
Parameters:
Name | Type |
---|---|
...args |
any[] |
Functions
buildServerlessFunctionsObj
▸ buildServerlessFunctionsObj(exportsObj
: object): object
Defined in src/index.ts:150
Parameters:
Name | Type |
---|---|
exportsObj |
object |
Returns: object
- [ key: string]: any
getLambdaExports
▸ getLambdaExports(exports
: object): [string, LambdaOutput][]
Defined in src/index.ts:132
Parameters:
Name | Type |
---|---|
exports |
object |
Returns: [string, LambdaOutput][]
httpSuccess
▸ httpSuccess(body
: any): object
Defined in src/index.ts:314
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): function & function & object
Defined in src/index.ts:54
Parameters:
Name | Type |
---|---|
args |
object & LambdaOptions |
Returns: function & function & object
makeCognitoLambda
▸ makeCognitoLambda‹TEvent, TResult›(args
: object): function & object
Defined in src/index.ts:117
Type parameters:
▪ TEvent
▪ TResult
Parameters:
▪ args: object
Name | Type |
---|---|
func |
Handler‹TEvent, TResult› |
pool |
string |
triggerOrTriggers |
CognitoTriggerType | CognitoTriggerType[] |
Returns: function & object
makeDDBLambda
▸ makeDDBLambda(args
: object & LambdaOptions): function & function & object
Defined in src/index.ts:75
Parameters:
Name | Type |
---|---|
args |
object & LambdaOptions |
Returns: function & function & object
makeEventBridgeLambda
▸ makeEventBridgeLambda‹TDetail›(args
: object): function & object
Defined in src/index.ts:97
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): function & object
Defined in src/index.ts:38
Parameters:
Name | Type |
---|---|
args |
LambdaOptions |
Returns: function & object
makeS3Lambda
▸ makeS3Lambda(args
: object & LambdaOptions): function & function & object
Defined in src/index.ts:42
Parameters:
Name | Type |
---|---|
args |
object & LambdaOptions |
Returns: function & function & object
makeSQSLambda
▸ makeSQSLambda(args
: object & LambdaOptions): function & function & object
Defined in src/index.ts:88
Parameters:
Name | Type |
---|---|
args |
object & LambdaOptions |
Returns: function & function & object
sendHttpResult
▸ sendHttpResult(statusCode
: number, body
: string, headers?
: undefined | object): object
Defined in src/index.ts:293
Parameters:
Name | Type |
---|---|
statusCode |
number |
body |
string |
headers? |
undefined | 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): void
Defined in src/index.ts:35
Parameters:
Name | Type |
---|---|
defaults |
LambdaArgs |
Returns: void
setWrapper
▸ setWrapper(wrapper
: typeof _wrapper): void
Defined in src/index.ts:31
Parameters:
Name | Type |
---|---|
wrapper |
typeof _wrapper |
Returns: void
@raydeck/serverless-lambda-builder - v2.5.0 › LambdaArgs
Interface: LambdaArgs
Hierarchy
LambdaArgs
Index
Properties
Properties
description Optional
• description? : undefined | string
Defined in src/index.ts:19
layers Optional
• layers? : string[]
Defined in src/index.ts:21
memorySize Optional
• memorySize? : undefined | number
Defined in src/index.ts:20
name Optional
• name? : undefined | string
Defined in src/index.ts:18
reservedConcurrency Optional
• reservedConcurrency? : undefined | number
Defined in src/index.ts:16
role Optional
• role? : undefined | string
Defined in src/index.ts:14
runtime Optional
• runtime? : "node10.x" | "node12.x"
Defined in src/index.ts:17
timeout Optional
• timeout? : undefined | number
Defined in src/index.ts:13
tracing Optional
• tracing? : undefined | false | true
Defined in src/index.ts:15
warmup Optional
• warmup? : undefined | false | true
Defined in src/index.ts:12
@raydeck/serverless-lambda-builder - v2.5.0 › LambdaOptions
Interface: LambdaOptions
Hierarchy
-
↳ LambdaOptions
Index
Properties
Properties
description Optional
• description? : undefined | string
Inherited from LambdaArgs.description
Defined in src/index.ts:19
func
• func: Handler‹any, any›
Defined in src/index.ts:24
layers Optional
• layers? : string[]
Inherited from LambdaArgs.layers
Defined in src/index.ts:21
memorySize Optional
• memorySize? : undefined | number
Inherited from LambdaArgs.memorySize
Defined in src/index.ts:20
name Optional
• name? : undefined | string
Inherited from LambdaArgs.name
Defined in src/index.ts:18
reservedConcurrency Optional
• reservedConcurrency? : undefined | number
Inherited from LambdaArgs.reservedConcurrency
Defined in src/index.ts:16
role Optional
• role? : undefined | string
Inherited from LambdaArgs.role
Defined in src/index.ts:14
runtime Optional
• runtime? : "node10.x" | "node12.x"
Inherited from LambdaArgs.runtime
Defined in src/index.ts:17
timeout Optional
• timeout? : undefined | number
Inherited from LambdaArgs.timeout
Defined in src/index.ts:13
tracing Optional
• tracing? : undefined | false | true
Inherited from LambdaArgs.tracing
Defined in src/index.ts:15
warmup Optional
• warmup? : undefined | false | true
Inherited from LambdaArgs.warmup
Defined in src/index.ts:12
@raydeck/serverless-lambda-builder - v2.5.0 › LambdaOutput
Interface: LambdaOutput
Hierarchy
↳ LambdaOutput
Callable
▸ (): Handler‹any, any›
Defined in src/index.ts:26
Returns: Handler‹any, any›
Index
Properties
- description
- func
- lambdaType
- layers
- memorySize
- name
- reservedConcurrency
- role
- runtime
- timeout
- tracing
- warmup
Properties
description Optional
• description? : undefined | string
Inherited from LambdaArgs.description
Defined in src/index.ts:19
func
• func: Handler‹any, any›
Inherited from LambdaOptions.func
Defined in src/index.ts:24
lambdaType
• lambdaType: string
Defined in src/index.ts:28
layers Optional
• layers? : string[]
Inherited from LambdaArgs.layers
Defined in src/index.ts:21
memorySize Optional
• memorySize? : undefined | number
Inherited from LambdaArgs.memorySize
Defined in src/index.ts:20
name Optional
• name? : undefined | string
Inherited from LambdaArgs.name
Defined in src/index.ts:18
reservedConcurrency Optional
• reservedConcurrency? : undefined | number
Inherited from LambdaArgs.reservedConcurrency
Defined in src/index.ts:16
role Optional
• role? : undefined | string
Inherited from LambdaArgs.role
Defined in src/index.ts:14
runtime Optional
• runtime? : "node10.x" | "node12.x"
Inherited from LambdaArgs.runtime
Defined in src/index.ts:17
timeout Optional
• timeout? : undefined | number
Inherited from LambdaArgs.timeout
Defined in src/index.ts:13
tracing Optional
• tracing? : undefined | false | true
Inherited from LambdaArgs.tracing
Defined in src/index.ts:15
warmup Optional
• warmup? : undefined | false | true
Inherited from LambdaArgs.warmup
Defined in src/index.ts:12