TypeScript and Netlify Functions

chiubaca

Alex Chiu

Posted on July 18, 2020

TypeScript and Netlify Functions

Did you know that Netlify Functions are just using AWS Lambdas behind the scenes?

This means you can use the same type definitions available for aws-lambda for your Netlify functions too. Install the aws-lamda types by running the following.

npm install @types/aws-lambda --save-dev
Enter fullscreen mode Exit fullscreen mode

You only need to import the APIGatewayProxyEvent, APIGatewayProxyCallback types like so.

import { APIGatewayProxyEvent, APIGatewayProxyCallback } from "aws-lambda";

export const handler = async function (
  event: APIGatewayProxyEvent,
  context: any,
  callback: APIGatewayProxyCallback
) {
  // Do some stuff here 
};
Enter fullscreen mode Exit fullscreen mode

Note, there are no type declarations available for context as this includes properties and methods specific to Netlify such as Netlify Identity .

However, having auto completion for event alone makes this hugely useful!

I'm putting together some TypeScript Netlify Functions examples over at this repo. Feel free to give it a star if you find it helpful.

💖 💪 🙅 🚩
chiubaca
Alex Chiu

Posted on July 18, 2020

Join Our Newsletter. No Spam, Only the good stuff.

Sign up to receive the latest update from our blog.

Related

TypeScript and Netlify Functions
typescript TypeScript and Netlify Functions

July 18, 2020