Package Exports
- @leanstacks/lambda-utils
- @leanstacks/lambda-utils/dist/index.esm.js
- @leanstacks/lambda-utils/dist/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@leanstacks/lambda-utils) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Lambda Utilities
A comprehensive TypeScript utility library for AWS Lambda functions. Provides pre-configured logging, API response formatting, configuration validation, and AWS SDK clientsβreducing boilerplate and promoting best practices.
Table of Contents
Installation
npm install @leanstacks/lambda-utilsRequirements
- Node.js 24.x or higher
- TypeScript 5.0 or higher
Quick Start
Logging Example
import { Logger, withRequestTracking } from '@leanstacks/lambda-utils';
const logger = new Logger().instance;
export const handler = async (event: any, context: any) => {
withRequestTracking(event, context);
logger.info('Processing request');
// Your Lambda handler logic here
return { statusCode: 200, body: 'Success' };
};API Response Example
import { success, badRequest } from '@leanstacks/lambda-utils';
export const handler = async (event: any) => {
if (!event.body) {
return badRequest({ message: 'Body is required' });
}
// Process request
return success({ message: 'Request processed successfully' });
};Features
- π Structured Logging β Pino logger pre-configured for Lambda with automatic AWS request context enrichment
- π€ API Response Helpers β Standard response formatting for API Gateway with proper HTTP status codes
- βοΈ Configuration Validation β Environment variable validation with Zod schema support
- π AWS SDK Clients β Pre-configured AWS SDK v3 clients for DynamoDB, Lambda, and more
- π Full TypeScript Support β Complete type definitions and IDE autocomplete
- β‘ Lambda Optimized β Designed for performance in serverless environments
Documentation
Comprehensive guides and examples are available in the docs directory:
| Guide | Description |
|---|---|
| Logging Guide | Configure and use structured logging with automatic AWS Lambda context |
| API Gateway Responses | Format responses for API Gateway with standard HTTP patterns |
| Configuration | Validate and manage environment variables with type safety |
| AWS Clients | Use pre-configured AWS SDK v3 clients in your handlers |
| Getting Started | Setup and first steps guide |
Usage
Logging
The Logger utility provides structured logging configured specifically for AWS Lambda:
import { Logger } from '@leanstacks/lambda-utils';
const logger = new Logger({
level: 'info', // debug, info, warn, error
format: 'json', // json or text
}).instance;
logger.info({ message: 'User authenticated', userId: '12345' });
logger.error({ message: 'Operation failed', error: err.message });β See Logging Guide for detailed configuration and best practices
API Responses
Generate properly formatted responses for API Gateway:
import { success, error, created, badRequest } from '@leanstacks/lambda-utils';
export const handler = async (event: any) => {
return success({
data: { id: '123', name: 'Example' },
});
};β See API Gateway Responses for all response types
Configuration Validation
Validate your Lambda environment configuration:
import { validateConfig } from '@leanstacks/lambda-utils';
import { z } from 'zod';
const configSchema = z.object({
DATABASE_URL: z.string().url(),
LOG_LEVEL: z.enum(['debug', 'info', 'warn', 'error']),
API_KEY: z.string(),
});
const config = validateConfig(configSchema);β See Configuration for validation patterns
AWS Clients
Use pre-configured AWS SDK v3 clients:
import { getDynamoDBClient, getLambdaClient } from '@leanstacks/lambda-utils';
const dynamoDB = getDynamoDBClient();
const lambda = getLambdaClient();
// Use clients for API callsβ See AWS Clients for available clients and examples
Examples
Example Lambda functions using Lambda Utilities are available in the repository:
- API Gateway with logging and response formatting
- Configuration validation and DynamoDB integration
- Error handling and structured logging
Reporting Issues
If you encounter a bug or have a feature request, please report it on GitHub Issues. Include as much detail as possible to help us investigate and resolve the issue quickly.
License
This project is licensed under the MIT License - see LICENSE file for details.
Support
- Issues & Questions: GitHub Issues
- Documentation: docs
- NPM Package: @leanstacks/lambda-utils
Changelog
See the project releases for version history and updates.