Building Lambda functions with TypeScript

You can use the Node.js runtime to run TypeScript code in Amazon Lambda. Because Node.js doesn't run TypeScript code natively, you must first transpile your TypeScript code into JavaScript. Then, use the JavaScript files to deploy your function code to Lambda. Your code runs in an environment that includes the Amazon SDK for JavaScript, with credentials from an Amazon Identity and Access Management (IAM) role that you manage. To learn more about the SDK versions included with the Node.js runtimes, see Runtime-included SDK versions.

Lambda supports the following Node.js runtimes.

Setting up a TypeScript development environment

Use a local integrated development environment (IDE) or text editor to write your TypeScript function code. You can’t create TypeScript code on the Lambda console.

You can use either esbuild or Microsoft's TypeScript compiler (tsc) to transpile your TypeScript code into JavaScript. The Amazon Serverless Application Model (Amazon SAM) and the Amazon Cloud Development Kit (Amazon CDK) both use esbuild.

When using esbuild, consider the following:

 {
  "compilerOptions": {
    "target": "es2020",
    "strict": true,
    "preserveConstEnums": true,
    "noEmit": true,
    "sourceMap": false,
    "module":"commonjs",
    "moduleResolution":"node",
    "esModuleInterop": true, 
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true, 
    "isolatedModules": true, 
  },
  "exclude": ["node_modules", "**/*.test.ts"]
}

Type definitions for Lambda

The @types/aws-lambda package provides type definitions for Lambda functions. Install this package when your function uses any of the following:

To add the Lambda type definitions to your function, install @types/aws-lambda as a development dependency:

npm install -D @types/aws-lambda

Then, import the types from aws-lambda:

import { Context, S3Event, APIGatewayProxyEvent } from 'aws-lambda';

export const handler = async (event: S3Event, context: Context) => {
    // Function code
};

The import ... from 'aws-lambda' statement imports the type definitions. It does not import the aws-lambda npm package, which is an unrelated third-party tool. For more information, see aws-lambda in the DefinitelyTyped GitHub repository.