Function workflow

Example: Here is an example of how to define a workflow:

const mywf = workflow({
  name: "mywf",
  handlers: {
    run: async (ctx: WorkflowContext, argument: any) => {
      return "Hello World";
    }
  }
});
Copy

Note:

• That a workflow must contain exactly one handler named 'run', and this handler must accept as a first argument a WorkflowContext.
• The workflow handlers other than 'run' must accept as a first argument a WorkflowSharedContext.
• The workflow handlers can not be named 'workflowSubmit', 'workflowAttach', 'workflowOutput' - as these are reserved keywords.

Example: To use the workflow, you can bind it to an endpoint:

endpoint.bind(mywf)
Copy

Example: To interact with the workflow, you can use the workflow client:

const client = ctx.workflowClient<typeof mywf>({ name: "mywf"});
const res = await client.run("Hello");
Copy

To use the workflow client from any other environment (like a browser), please refer to the documentation. https://docs.restate.dev