https://github.com/netlify/functions

JavaScript and TypeScript utilities for Netlify Functions.
https://github.com/netlify/functions

aws functions javascript lambda-functions netlify netlify-functions netlify-lambda netlify-lambda-functions nodejs serverless typescript

Last synced: 4 months ago
JSON representation

JavaScript and TypeScript utilities for Netlify Functions.

• Host: GitHub
• URL: https://github.com/netlify/functions
• Owner: netlify
• License: mit
• Created: 2021-02-22T12:35:13.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-03-11T01:36:42.000Z (4 months ago)
• Last Synced: 2024-03-11T02:42:23.425Z (4 months ago)
• Topics: aws, functions, javascript, lambda-functions, netlify, netlify-functions, netlify-lambda, netlify-lambda-functions, nodejs, serverless, typescript
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/@netlify/functions
• Size: 2.22 MB
• Stars: 38
• Watchers: 13
• Forks: 20
• Open Issues: 27
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Lists

• awesome-jam-stack - Netlify Functions
• awesome-stars - functions
• awesome - functions - Playground repo for Netlify’s Lambda Functions (HTML)

README

        
# ![functions](functions.png)

[![Build](https://github.com/netlify/functions/workflows/Build/badge.svg)](https://github.com/netlify/functions/actions)

[![Node](https://img.shields.io/node/v/@netlify/functions.svg?logo=node.js)](https://www.npmjs.com/package/@netlify/functions)

JavaScript and TypeScript utilities for [Netlify Functions](https://docs.netlify.com/functions/overview/).

## Installation

```

npm install @netlify/functions

```

## Usage

### On-demand Builders

To use On-demand Builders, wrap your function handler with the `builder` function.

- With JavaScript:

  ```js

  const { builder } = require('@netlify/functions')

  const handler = async (event, context) => {

    return {

      statusCode: 200,

      body: JSON.stringify({ message: 'Hello World' }),

    }

  }

  exports.handler = builder(handler)

  ```

- With TypeScript:

  ```ts

  import { builder, Handler } from '@netlify/functions'

  const myHandler: Handler = async (event, context) => {

    return {

      statusCode: 200,

      body: JSON.stringify({ message: 'Hello World' }),

    }

  }

  const handler = builder(myHandler)

  export { handler }

  ```

### Scheduled Functions (currently in beta)

To use Scheduled Functions, wrap your function handler with the `schedule` function.

- With JavaScript:

  ```js

  const { schedule } = require('@netlify/functions')

  exports.handler = schedule('5 4 * * *', async () => {

    console.log("It's 04:05 AM!")

  })

  ```

- With TypeScript:

  ```ts

  import { schedule } from '@netlify/functions'

  export const handler = schedule("5 4 * * *", async () => {

    console.log("It's 04:05 AM!")

  })

  ```

### TypeScript typings

This module exports typings for authoring Netlify Functions in TypeScript.

```ts

import { Handler } from '@netlify/functions'

const handler: Handler = async (event, context) => {

  return {

    statusCode: 200,

    body: JSON.stringify({ message: 'Hello World' }),

  }

}

export { handler }

```

The following types are exported:

- `Handler`

- `HandlerCallback`

- `HandlerContext`

- `HandlerEvent`

- `HandlerResponse`

## Contributors

Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for instructions on how to set up and work on this repository. Thanks

for contributing!