1.0.0 • Published 5 years ago

serverless-plugin-ts-validation v1.0.0

Weekly downloads
4
License
MIT
Repository
github
Last release
5 years ago

serverless-plugin-ts-validation

serverless

This is a serverless plugin made to enable automatic validation of your AWS lambda functions from typescript interfaces.

This plugin should be compatible with other plugins such as the serverless-plugin-typescript.

Under the hood it uses the ts-json-schema-generator library to generate a json schema from an interface, and sends it to AWS proxy as an input validator.

The validation enables AWS proxy to validate the input, without needing the lambda functions to be called (saving you some money 💰) and ensuring the inputs to your functions are valid.

Notes:

  • This currently works for simple cases, but since the json schema we create is version 7.0, and AWS only supports version 4.0, there might be cases where AWS rejects the schema generated.
  • The schema files are not currently stored locally, this could be a potential future feature.
  • There are no provided default tsconfig.json, you will need to provide your own in the root directory.

This plugin would not have been possible without:

  • ts-json-schema-generator
  • serverless-plugin-typescript

PRs welcomed! 🙂