@types/serverless

What is @types/serverless?

@types/serverless provides TypeScript definitions for the Serverless Framework, allowing developers to use TypeScript's type-checking features when working with Serverless applications.

What are @types/serverless's main functionalities?

Serverless Configuration

This feature allows you to define the configuration for a Serverless service, including the provider, runtime, and functions. The TypeScript definitions help ensure that the configuration adheres to the expected structure.

{
  "service": "my-service",
  "provider": {
    "name": "aws",
    "runtime": "nodejs14.x"
  },
  "functions": {
    "hello": {
      "handler": "handler.hello"
    }
  }
}

Function Definitions

This feature allows you to define functions and their associated events, such as HTTP endpoints. The TypeScript definitions provide type-checking for the function configuration, ensuring that the events and handlers are correctly specified.

{
  "functions": {
    "hello": {
      "handler": "handler.hello",
      "events": [
        {
          "http": {
            "path": "hello",
            "method": "get"
          }
        }
      ]
    }
  }
}

Custom Resources

This feature allows you to define custom AWS resources within your Serverless application. The TypeScript definitions help ensure that the resource configurations are valid and correctly structured.

{
  "resources": {
    "Resources": {
      "MyDynamoDBTable": {
        "Type": "AWS::DynamoDB::Table",
        "Properties": {
          "TableName": "my-table",
          "AttributeDefinitions": [
            {
              "AttributeName": "id",
              "AttributeType": "S"
            }
          ],
          "KeySchema": [
            {
              "AttributeName": "id",
              "KeyType": "HASH"
            }
          ],
          "ProvisionedThroughput": {
            "ReadCapacityUnits": 5,
            "WriteCapacityUnits": 5
          }
        }
      }
    }
  }
}

Other packages similar to @types/serverless

serverless

The serverless package is the core framework for building serverless applications. It provides the CLI and core functionality for deploying and managing serverless services. Unlike @types/serverless, which provides TypeScript definitions, the serverless package is the actual tool used to deploy and manage serverless applications.

serverless-offline

serverless-offline is a plugin for the Serverless Framework that allows you to run your serverless applications locally. It simulates AWS Lambda and API Gateway, enabling local development and testing. While @types/serverless provides type definitions, serverless-offline focuses on local development capabilities.

serverless-webpack

serverless-webpack is a plugin that integrates Webpack with the Serverless Framework, allowing you to bundle your serverless functions with Webpack. This is useful for optimizing and managing dependencies. Unlike @types/serverless, which provides type definitions, serverless-webpack focuses on build optimization and dependency management.

README

Installation

npm install --save @types/serverless

Summary

This package contains type definitions for serverless (https://github.com/serverless/serverless#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/serverless.

Additional Details

• Last updated: Mon, 05 Oct 2020 02:04:35 GMT
• Dependencies: none
• Global values: none

Credits

These definitions were written by Hassan Khan, Jonathan M. Wilbur, Alex Pavlenko, Frédéric Barthelet, Bryan Hunter, and Thomas Aribart.