do-functions-server

Functions dev server

Documentation | do-functions-server NPM

A server to test running your functions locally, before deploying.

npx do-functions-server .

Spins up a simple nodejs webserver that serves an endpoint for each function in a Digital Ocean Functions structured project.

Serves endpoints on http://localhost:62747 with URL paths {packageName}/{functionName}.

Expected structure:

packages/
    packageName/
        functionName.js
project.yml

Highly recommended to use in conjunction with do-functions which produces the correct structure as build output.

See getting-started#packages-structure for a guide to develop functions.

Package script

You can add this script to your package.json to make it more convenient to test your functions:

{
  "name": "your-package",
  "scripts": {
    "serve": "do-functions-server ."
  },
  "devDependencies": {
    "do-functions-server": "^1.0.1"
  }
}

Now you simply need to run npm run serve to start up a server of your functions.

Command line arguments

do-functions-server BUILD_DIRECTORY [OPTIONS]

Available options:
 --project-yml project.yml  a custom project.yml location to read the config from (relative path)
 --port 62747               port for server to listen on