@types/aws-lambda

What is @types/aws-lambda?

The @types/aws-lambda package provides TypeScript type definitions for AWS Lambda. This allows developers to write Lambda functions in TypeScript with type checking, making development more robust and error-free. It covers various AWS Lambda event sources such as API Gateway, S3, DynamoDB, and more, providing types for event objects, context, and handler responses.

What are @types/aws-lambda's main functionalities?

API Gateway Proxy Handler

Defines a handler for AWS Lambda functions triggered by an API Gateway event, allowing you to process HTTP requests and return responses.

import { APIGatewayProxyHandler } from 'aws-lambda';

export const handler: APIGatewayProxyHandler = async (event, context) => {
  return {
    statusCode: 200,
    body: JSON.stringify({ message: 'Hello from Lambda!' }),
  };
};

S3 Event Handler

Provides types for handling S3 bucket events, such as object creation or deletion, enabling you to react to changes in S3 buckets.

import { S3Handler } from 'aws-lambda';

export const handler: S3Handler = async (event, context) => {
  console.log('S3 event:', event);
  // Process S3 event
};

DynamoDB Stream Handler

Facilitates the processing of DynamoDB stream events, allowing you to handle changes in DynamoDB tables in real-time.

import { DynamoDBStreamHandler } from 'aws-lambda';

export const handler: DynamoDBStreamHandler = async (event, context) => {
  console.log('DynamoDB Stream event:', event);
  // Process DynamoDB stream records
};

Other packages similar to @types/aws-lambda

aws-sdk

While not a direct alternative, the aws-sdk package is often used alongside @types/aws-lambda for interacting with AWS services within Lambda functions. It provides JavaScript objects for AWS services but does not offer TypeScript types for Lambda events.

serverless

The serverless framework helps you build serverless applications using AWS Lambda and other providers. It abstracts away some of the complexities of deploying and managing Lambda functions but does not provide TypeScript definitions for Lambda events.

aws-lambda

This is the JavaScript SDK for AWS Lambda, allowing you to write Lambda functions. However, it does not provide TypeScript type definitions, which is where @types/aws-lambda comes in to complement it by offering types for better development experience in TypeScript.

README

Installation

npm install --save @types/aws-lambda

Summary

This package contains type definitions for AWS Lambda (http://docs.aws.amazon.com/lambda).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/aws-lambda.

Additional Details

• Last updated: Wed, 03 May 2023 05:02:47 GMT
• Dependencies: none
• Global values: AWSLambda

Credits

These definitions were written by James Darbyshire, Michael Skarum, Stef Heyenrath, Rich Buggy, Yoriki Yamaguchi, wwwy3y3, Ishaan Malhi, Michael Marner, Daniel Cottone, Kostya Misura, Markus Tacker, Palmi Valgeirsson, Danilo Raisi, Simon Buchan, David Hayden, Chris Redekop, Aneil Mallavarapu, Jeremy Nagel, Louis Larry, Daniel Papukchiev, Oliver Hookins, Trevor Leach, James Gregory, Erik Dalén, Loïk Gaonac'h, Roberto Zen, Grzegorz Redlicki, Juan Carbonel, Peter McIntyre, Alex Bolenok, Marian Zange, Alexander Pepper, Alessandro Palumbo, Sachin Shekhar, Ivan Martos, Zach Anthony, Peter Savnik, Benoit Boure, James Lakin, Ross Gerbasi, and Joey Kilpatrick.