Getting Started

Prerequisites

• An Nhost project connected to a GitHub repository
• The Nhost CLI installed for local development

Create a Function

Place a .js or .ts file inside the ./functions directory of your project:

JavaScript

./functions/hello.js

export default (req, res) => {
  res.status(200).send(`Hello ${req.query.name}!`)
}

TypeScript

./functions/hello.ts

import type { Request, Response } from 'express'

export default (req: Request, res: Response) => {
  res.status(200).send(`Hello ${req.query.name}!`)
}

Note

Install @types/express for TypeScript type definitions.

Test Locally

Start the Nhost CLI and call your function:

curl https://local.functions.local.nhost.run/v1/hello?name=World

Deploy

Push your code to the connected GitHub repository. Nhost automatically deploys your functions as part of a Deployment.

Echo Example

A more complete example that returns request metadata:

./functions/echo.ts

import process from 'node:process'
import type { Request, Response } from 'express'

export default (req: Request, res: Response) => {
  res.status(200).json({
    headers: req.headers,
    query: req.query,
    node: process.version,
    arch: process.arch,
    invocationId: req.invocationId,
  })
}