Add Support for ES6 and TypeScript
AWS Lambda supports Node.js v10.x and v12.x. However, the supported syntax is a little different when compared to the more advanced ECMAScript flavor of JavaScript that our frontend React app supports. It makes sense to use similar ES features across both parts of the project – specifically, we’ll be relying on ES imports/exports in our handler functions.
Additionally, our frontend React app automatically supports TypeScript, via Create React App. And while we are not using TypeScript in this guide, it makes sense to have a similar setup for your backend Lambda functions. So you can use it in your future projects.
To do this we typically need to install Babel, TypeScript, Webpack, and a long list of other packages. This can add a ton of extra config and complexity to your project.
To help with this we created, serverless-bundle
. This is a Serverless Framework plugin that has a few key advantages:
- Only one dependency
- Supports ES6 and TypeScript
- Generates optimized packages
- Linting Lambda functions using ESLint
- Supports transpiling unit tests with babel-jest
- Source map support for proper error messages
It’s automatically included in the starter project we used in the previous chapter — serverless-nodejs-starter
. For TypeScript, we have a starter for that as well — serverless-typescript-starter
.
However, if you are looking to add ES6 and TypeScript support to your existing Serverless Framework projects, you can do this by installing serverless-bundle:
$ npm install --save-dev serverless-bundle
And including it in your serverless.yml
using:
plugins:
- serverless-bundle
To run your tests, add this to your package.json
.
"scripts": {
"test": "serverless-bundle test"
}
ES6 Lambda Functions
Let’s look at the Lambda function that comes with our starter project.
Your handler.js
should look like this.
export const hello = async (event, context) => {
return {
statusCode: 200,
body: JSON.stringify({
message: `Go Serverless v2.0! ${(await message({ time: 1, copy: 'Your function executed successfully!'}))}`,
}),
};
};
const message = ({ time, ...rest }) => new Promise((resolve, reject) =>
setTimeout(() => {
resolve(`${rest.copy} (with a delay)`);
}, time * 1000)
);
Let’s run this. In your project root run:
$ serverless invoke local --function hello
You should see something like this in your terminal.
{
"statusCode": 200,
"body": "{\"message\":\"Go Serverless v2.0! Your function executed successfully! (with a delay)\"}"
}
In the above command we are asking Serverless Framework to (locally) invoke a Lambda function called hello
. This in turn will run the hello
method that we are exporting in our handler.js
.
Here we are directly invoking the Lambda function. Though once deployed, we’ll be invoking this function through the /hello
API endpoint (as we talked about in the last chapter).
Now we are almost ready to deploy our Lambda function and API. But before we do that let’s quickly look at one of the other things that’s been set up for us in this starter project.
Optimized Packages
By default Serverless Framework creates a single package for all your Lambda functions. This means that when a Lambda function is invoked, it’ll load all the code in your app. Including all the other Lambda functions. This negatively affects performance as your app grows in size. The larger your Lambda function packages, the longer the cold starts.
To turn this off and it to ensure that Serverless Framework is packaging our functions individually, add the following to your serverless.yml
.
package:
individually: true
This should be on by default in our starter project.
Note that, with the above option enabled, serverless-bundle can use Webpack to generate optimized packages using a tree shaking algorithm. It’ll only include the code needed to run your Lambda function and nothing else!
Now we are ready to deploy our backend API.
For help and discussion
Comments on this chapter