@dxos/functions NPM

@dxos/functions

Functions SDK.

Installation

pnpm i @dxos/functions

Writing functions

Create a manifest file at the package root:

functions:
  hello:
    description: Test function.

NOTE: The function name must match the filename (e.g., src/functions/hello.ts).

Create an example function:

import { FunctionContext } from '@dxos/functions';

export default (event: any, context: FunctionContext) => {
  const identity = context.client.halo.identity.get();
  return context
    .status(200)
    .succeed({ 
      message: `Hello ${identity?.profile?.displayName}` 
    });
};

Running functions with the dev server:

Configure the agent to run functions on a given port:

# ~/.config/dx/profile/default.yml
runtime:
  agent:
    functions:
      port: 7001

Start functions in dev mode (from the related package):

dx function dev -r ts-node/register --verbose

NOTE: -r ts-node/register configures native TypesScript support.

Install nodemon to support live reloading:

npm i -g nodemon

nodemon -w ./src -e ts --exec $(git rev-parse --show-toplevel)/packages/devtools/cli/bin/dev \
  function dev -r ts-node/register --verbose

Invoking functions

NOTE: The port (7001) must match the one in config.

curl http://localhost:7001/dev/hello -X POST -H 'Content-Type: application/json' -w '\n' --data '{ "message": "Hello World!" }'

DXOS Resources

Contributions

Your ideas, issues, and code are most welcome. Please take a look at our community code of conduct, the issue guide, and the PR contribution guide.

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

10 months ago

10 months ago

11 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

9 months ago

12 months ago

12 months ago

10 months ago

12 months ago

10 months ago

10 months ago

11 months ago

9 months ago

12 months ago

12 months ago

12 months ago

12 months ago

9 months ago

12 months ago

12 months ago

12 months ago

9 months ago

12 months ago

12 months ago

10 months ago

9 months ago

9 months ago

12 months ago

12 months ago

11 months ago

11 months ago

11 months ago

11 months ago

12 months ago

11 months ago

12 months ago

12 months ago

9 months ago

12 months ago

10 months ago

12 months ago

12 months ago

9 months ago

10 months ago

12 months ago

11 months ago

11 months ago

12 months ago

12 months ago

12 months ago

9 months ago

10 months ago

11 months ago

10 months ago

12 months ago

12 months ago

10 months ago

10 months ago

12 months ago

10 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

10 months ago

12 months ago

12 months ago

11 months ago

12 months ago

12 months ago

10 months ago

10 months ago

11 months ago

12 months ago

12 months ago

12 months ago

12 months ago

10 months ago

10 months ago

12 months ago

12 months ago

12 months ago

11 months ago

11 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

9 months ago

12 months ago

10 months ago

10 months ago

11 months ago

12 months ago

10 months ago

12 months ago

12 months ago

12 months ago

11 months ago

11 months ago

12 months ago

12 months ago

12 months ago

12 months ago

9 months ago

9 months ago

11 months ago

10 months ago

10 months ago

12 months ago

10 months ago

11 months ago

12 months ago

10 months ago

9 months ago

12 months ago

12 months ago

9 months ago

12 months ago

11 months ago

10 months ago

10 months ago

10 months ago

10 months ago

12 months ago

12 months ago

12 months ago

12 months ago

11 months ago

12 months ago

11 months ago

11 months ago

12 months ago

12 months ago

12 months ago

9 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

11 months ago

10 months ago

12 months ago

10 months ago

10 months ago

10 months ago

9 months ago

11 months ago

10 months ago

12 months ago

11 months ago

12 months ago

12 months ago

12 months ago

12 months ago

10 months ago

12 months ago

9 months ago