@raydeck/serverless-base v1.0.5
@raydeck/serverless-base - v1.0.5
Usage
serverless-base [options] [command]Options
- -p --path \<
path> Working path for serverless package context (default:/Users/ray/Documents/GitHub/serverless-base)
Commands
show
Show the serverless configuration for this package
Usage
serverless-base show [options]set \<key> \<value>
Update a single key to a specific value
Usage
serverless-base set [options] <key> <value>Options
- -t --targetFile \<
filename> File to update - one of package.json or .serverlessrc (default:.serverlessrc) - -j --json Treat value as JSON string
- -s --stage \<
stage> Set value within a stage key
dependency
Subcommands for dependency management
Usage
serverless-base dependency [options] [command]Options
- -s --stage \<
stage> Set stage key for condition for this dependency
Subcommands
add \<path> name
add a dependency
Usage
serverless-base dependency add [options] <path> [name]remove \<name>
remove a dependency
Usage
serverless-base dependency remove [options] <name>Index
Variables
Functions
Variables
Const dep
• dep: Command‹› = commander .command("dependency") .description("Subcommands for dependency management") .option( "-s --stage ", "Set stage key for condition for this dependency" )
Defined in bin.ts:38
Functions
getServerlessConfig
▸ getServerlessConfig(path: string): object
Defined in index.ts:8
Get the serverless object from package.json, serverless.config.js and .serverlessrc
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
path | string | process.cwd() | Path to serverless package (default is current path) |
Returns: object
- [ key: string]: any
updateServerlessConfig
▸ updateServerlessConfig(configUpdates: object, path: string, targetFile: "package.json" | ".serverlessrc"): void
Defined in index.ts:64
Update a serverless config (shallow only - replacing a tree element replaces the whole tree)
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
configUpdates | object | - | Map of updates to change (e.g. {name: "newName"}) |
path | string | process.cwd() | Path to the serverless package (default is current dir) |
targetFile | "package.json" | ".serverlessrc" | ".serverlessrc" | Whether to update package.json or .serverlessrc - defaults to latter |
Returns: void
writeServerlessConfig
▸ writeServerlessConfig(newConfigMap: object, path: string, targetFile: "package.json" | ".serverlessrc"): void
Defined in index.ts:37
Save a new config map
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
newConfigMap | object | - | New set of serverless considerations |
path | string | process.cwd() | Path to the serverless package (default current path) |
targetFile | "package.json" | ".serverlessrc" | ".serverlessrc" | WHether to amend package.json or recreate .serverlessrc (defaults to the latter) |
Returns: void