Powertools for AWS Lambda (TypeScript)

Powertools for AWS Lambda (TypeScript) is a developer toolkit to implement Serverless best practices and increase developer velocity.

You can use the library in both TypeScript and JavaScript code bases.

Also available in Python, Java, and .NET.

Documentation | npmjs.com | Roadmap | Examples

Features

Find the complete project's documentation here.

• Tracer - Utilities to trace Lambda function handlers, and both synchronous and asynchronous functions
• Logger - Structured logging made easier, and a middleware to enrich log items with key details of the Lambda context
• Metrics - Custom Metrics created asynchronously via CloudWatch Embedded Metric Format (EMF)
• Event Handler - Lightweight routing to reduce boilerplate for API Gateway REST/HTTP API, ALB and Lambda Function URLs
• Parameters - High-level functions to retrieve one or more parameters from AWS SSM Parameter Store, AWS Secrets Manager, AWS AppConfig, and Amazon DynamoDB
• Idempotency - Class method decorator, Middy middleware, and function wrapper to make your Lambda functions idempotent and prevent duplicate execution based on payload content
• Batch Processing - Utility to handle partial failures when processing batches from Amazon SQS, Amazon Kinesis Data Streams, and Amazon DynamoDB Streams.
• JMESPath Functions - Built-in JMESPath functions to easily deserialize common encoded JSON payloads in Lambda functions.
• Parser (Zod) - Utility that provides data validation and parsing using Zod, a TypeScript-first schema declaration and validation library.
• Validation - JSON Schema validation for events and responses, including JMESPath support to unwrap events before validation.
• Kafka - Utility to easily handle message deserialization and parsing of Kafka events in AWS Lambda functions.
• Data Masking - Utility to encrypt, decrypt, or irreversibly erase sensitive information to protect data confidentiality.
• Signer - Utility to sign HTTP requests to AWS services using AWS Signature Version 4 (SigV4), so you can call IAM-authenticated endpoints from your Lambda functions.

Install

You can use Powertools for AWS Lambda (TypeScript) by installing it with your favorite dependency management, or via Lambda Layers. All features are available as individual packages, so you can install only the ones you need, for example:

• Logger: npm install @aws-lambda-powertools/logger
• Metrics: npm install @aws-lambda-powertools/metrics
• Tracer: npm install @aws-lambda-powertools/tracer
• Event Handler: npm install @aws-lambda-powertools/event-handler
• Parameters: npm install @aws-lambda-powertools/parameters @aws-sdk/client-ssm see documentation for other providers
• Idempotency: npm install @aws-lambda-powertools/idempotency @aws-sdk/client-dynamodb @aws-sdk/lib-dynamodb see documentation for other providers
• Batch Processing: npm install @aws-lambda-powertools/batch
• JMESPath Functions: npm install @aws-lambda-powertools/jmespath
• Parser: npm install @aws-lambda-powertools/parser zod@~3
• Validation: npm install @aws-lambda-powertools/validation
• Kafka: npm install @aws-lambda-powertools/kafka see documentation for Avro and Protobuf support
• Data Masking: npm install @aws-lambda-powertools/data-masking @aws-crypto/client-node
• Signer: npm install @aws-lambda-powertools/signer

Examples

You can find examples of how to use Powertools for AWS Lambda (TypeScript) in the examples directory. The directory contains code snippets around certain features as well as an is a simple REST API application that can be deployed via either AWS CDK or AWS SAM.

How to support Powertools for AWS Lambda (TypeScript)?

Becoming a reference customer

Knowing which companies are using this library is important to help prioritize the project internally. If your company is using Powertools for AWS Lambda (TypeScript), you can request to have your name and logo added to the README file by raising a Support Powertools for AWS Lambda (TypeScript) (become a reference) issue.

The following companies, among others, use Powertools:

• Alma Media
• AppYourself
• Bailey Nelson
• Banxware
• Caylent
• Certible
• Codeac
• EF Education First
• Elva
• Flyweight
• FraudFalcon
• globaldatanet
• Guild
• Hashnode
• Instil
• LocalStack
• Ours Privacy
• Perfect Post
• Sennder
• tecRacer GmbH & Co. KG
• Trek10
• WeSchool

Sharing your work

Share what you did with Powertools for AWS Lambda (TypeScript) 💞💞. Blog post, workshops, presentation, sample apps and others. Check out what the community has already shared about Powertools for AWS Lambda (TypeScript).

Using Lambda Layer

This helps us understand who uses Powertools for AWS Lambda (Typescript) in a non-intrusive way, and helps us gain future investments for other Powertools for AWS Lambda languages. When using Layers, you can add Powertools for AWS Lambda as a dev dependency to not impact the development process.

Credits

• Structured logging initial implementation from aws-lambda-logging
• Powertools for AWS Lambda idea DAZN Powertools

Connect

• Powertools for AWS Lambda on Discord: #typescript - Invite link
• Email: aws-powertools-maintainers@amazon.com

Security disclosures

If you think you’ve found a potential security issue, please do not post it in the Issues. Instead, please follow the vulnerability reporting instructions or email AWS security directly.

License

This library is licensed under the MIT-0 License. See the LICENSE file.