lambda-toolkit 2.0.0-dev.1 → 2.0.0-dev.2

package/dist/index.cjs

@@ -557,7 +557,14 @@ class LambdaApi {
   /**
    * Creates a new Lambda Api
    *
-   * @param {Object} headers Any headers you want to be included in all responses
+   * @param {Object} args
+   * @param {Object} [args.headers={}] Any headers to be included in all responses. Defaults to none.          
+   * @param {'camelcase'|'snakecase'} [args.transformRequest=false]
+   *                                  Transform the request query string, parameters and body to camelCase or snake_case.
+   *                                  Defaults to no transformation.
+   * @param {'camelcase'|'snakecase'} [args.transformResponse=false]
+   *                                  Transform the response body to camelCase or snake_case
+   *                                  Defaults to no transformation.
    */
   constructor( { headers = {}, transformRequest = false, transformResponse = false } = {} ) {
     Validator.transformRequest( transformRequest );
@@ -610,10 +617,9 @@ class LambdaApi {
    * Register an automatic error code response for given error class (constructor name)
    *
    * @param {Object} args
-   * @param {string} args.code The HTTP status code to return
    * @param {class} args.errorType The error class
+   * @param {number} args.code The HTTP status code to return
    * @param {string} [args.message=null] Optional message to return for the status code, if not present will default to Error.message
-   * @param {message} [args.errorType] And optional message to display
    */
   addErrorHandler( { errorType, code, message = null } = {} ) {
     Validator.statusCode( code );
@@ -622,7 +628,7 @@ class LambdaApi {
   }
 
   /**
-   * Init the flow using a given AWS Lambda APIGateway event (v2 syntax)
+   * Init the flow using a given AWS Lambda APIGateway event
    *
    * @param {Object} ApiGatewayPayload The raw API Gateway event
    * @returns {Object} The http response with status, body and headers

package/dist/index.mjs

@@ -556,7 +556,14 @@ class LambdaApi {
   /**
    * Creates a new Lambda Api
    *
-   * @param {Object} headers Any headers you want to be included in all responses
+   * @param {Object} args
+   * @param {Object} [args.headers={}] Any headers to be included in all responses. Defaults to none.          
+   * @param {'camelcase'|'snakecase'} [args.transformRequest=false]
+   *                                  Transform the request query string, parameters and body to camelCase or snake_case.
+   *                                  Defaults to no transformation.
+   * @param {'camelcase'|'snakecase'} [args.transformResponse=false]
+   *                                  Transform the response body to camelCase or snake_case
+   *                                  Defaults to no transformation.
    */
   constructor( { headers = {}, transformRequest = false, transformResponse = false } = {} ) {
     Validator.transformRequest( transformRequest );
@@ -609,10 +616,9 @@ class LambdaApi {
    * Register an automatic error code response for given error class (constructor name)
    *
    * @param {Object} args
-   * @param {string} args.code The HTTP status code to return
    * @param {class} args.errorType The error class
+   * @param {number} args.code The HTTP status code to return
    * @param {string} [args.message=null] Optional message to return for the status code, if not present will default to Error.message
-   * @param {message} [args.errorType] And optional message to display
    */
   addErrorHandler( { errorType, code, message = null } = {} ) {
     Validator.statusCode( code );
@@ -621,7 +627,7 @@ class LambdaApi {
   }
 
   /**
-   * Init the flow using a given AWS Lambda APIGateway event (v2 syntax)
+   * Init the flow using a given AWS Lambda APIGateway event
    *
    * @param {Object} ApiGatewayPayload The raw API Gateway event
    * @returns {Object} The http response with status, body and headers

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lambda-toolkit",
-  "version": "2.0.0-dev.1",
+  "version": "2.0.0-dev.2",
   "description": "A set of tools to help and simplify Node Js code development for AWS Lambdas",
   "files": [
     "./license",