FaasJS
Home
  • Guide
  • Documents
  • Templates
  • Changelog
  • Ecosystem

    • Docker Images
  • Github
  • Contributing
  • Sponsor
  • Security
Home
  • Guide
  • Documents
  • Templates
  • Changelog
  • Ecosystem

    • Docker Images
  • Github
  • Contributing
  • Sponsor
  • Security

Documents / @faasjs/workflow / done

Function: done()

done<TData>(data?): DoneWorkflowInstruction<TData>

Mark the current step as done.

Type Parameters

TData

TData = unknown

Parameters

data?

TData

Optional JSON-serializable data to persist on the step.

Returns

DoneWorkflowInstruction<TData>

Example

import { done } from '@faasjs/workflow'

async function sendReceipt({ params }) {
  await emailReceipt(params.orderId)

  return done({
    orderId: params.orderId,
    emailed: true,
  })
}