lambda-dev-kit

0.0.8 • Public • Published

Lambda Dev Kit

LambdaKit is a package that helps you develop Lambda Functions in AWS. With this package in place, you can very quickly run local tests, build involving packages, create ZIP packages for deployment, and deploy them.


In particular, in JavaScript, there are cases where external packages are used, or TypeScript is used, and it is necessary to build and resolve modules when running in Lambda. This package suggests a better way and provides a quick way to perform that function. With this package, you will be able to develop more comfortably.


Usage

Build script

npx ld-build -e src/index.js -o dist/app/index.js

Of course, you can build TypeScript as well.

npx ld-build -e src/index.ts -o dist/app/index.js

If you specify the static folder, static files will be copied to the output destination. This allows external resources such as JSON and binaries to be used in Lambda as well.

npx ld-build -e src/app/index.ts -s src/app -o dist/app/index.js

Run script

Run the built script.

npx ld-run -e dist/app/index.js

By specifying JSON describing the event, it can be passed as an argument.

npx ld-run -e dist/app/index.js -i samples/test.json

ZIP packages

You can generate a ZIP file for deployment with a simple command.

npx ld-pack -e ./dist/app -o dist/app.zip

By specifying the static folder when building, static resources (images, JSON, binaries, etc.) can be packaged at the same time.

Deploy your function

You can do everything from build to deployment in one go. Usually, a Function is updated in a very short time unless it is a large build.

npx ld-deploy -n "your-function-name" -e ./src/index.ts -o ./dist/app/index.js -d ./dist/app -z ./dist/app.zip

NPM Script Snippets

Example

{
    "build:app": "ld-build -e src/index.ts -o dist/app/index.js",
    "run:app": "yarn build:app; ld-run -e dist/app/index.js",
    "deploy:app": "ld-deploy -n test -e ./src/index.ts -o ./dist/app/index.js -d ./dist/app -z ./dist/app.zip"
}

With this kind of description, it is possible to specify JSON at any time when running tests.

Example

yarn run:app -i ./samples/test.json

Package Sidebar

Install

npm i lambda-dev-kit

Weekly Downloads

7

Version

0.0.8

License

MIT

Unpacked Size

10.3 kB

Total Files

7

Last publish

Collaborators

  • yuki_u