Node Lambda Utils
Installation
npm install @clipmx/lambda-utils
Usage
Refer to the API docs for usage examples
Technologies Used
- TypeScript
- Jest for testing
- Sinon for test mocks
- TypeDoc for auto-generated documentation
Contributing
Anything that is reusable in our Node Lambdas would be a good addition to this library.
git clone git@github.com:ClipMX/node.lambda-utils.git
Build Tests
npm run test:watch
Add Usage Examples
TypeDoc will generate API documentation based on the TypeScript types used in the code. TypeDoc will also
pull any doc strings into the generated code, which is useful for providing a little more description and
usage examples to each Module, Class, Variable, Function, etc. The doc string should be written in
MarkDown to take advantage of syntax highlighted code blocks.
TypeScript Resources
Publishing
- Create a release branch off of master.
- Rebuild docs
npm run build:docs - Commit all changes
npm version [major|minor|patch]- Create a pull request for release branch
npm publish --access public