Interface DurableHandler<_Input, _Output, _Requirements, _Rpcs>

rpcHandlers

onAlarm

• onAlarm(): Effect<void, never, _Requirements | BaseServices>

  Called when the process's alarm is triggered.

  Returns Effect<void, never, _Requirements | BaseServices>

  Throws

  Throwing in the handler will terminate the process with an error.

onChildEvent

• onChildEvent(
      event: ChildEvent<unknown>,
  ): Effect<void, never, _Requirements | BaseServices>

  Called when the process's child process produces output or exits.

  This allows the parent process to hibernate while a long-running child process is running.

  Parameters

  • event: ChildEvent<unknown>

  Returns Effect<void, never, _Requirements | BaseServices>

onInput

• onInput(input: _Input): Effect<void, never, _Requirements | BaseServices>

  Called when there's input available to process.

  The function can be called in parallel.

  Parameters

  • input: _Input

  Returns Effect<void, never, _Requirements | BaseServices>

  A signal indicating to the runtime whether the process is finished, or should be resumed later.

  Throws

  Throwing in the handler will terminate the process with an error.

  Note: This function should aim to complete in under 5 seconds to avoid exceeding limits in serverless environments.

onSpawn

• onSpawn(): Effect<void, never, _Requirements | BaseServices>

  Called when the process is spawned. Not called for processes that are resumed from a previously suspended state.

  Returns Effect<void, never, _Requirements | BaseServices>

  A signal indicating to the runtime whether the process is finished, or should be resumed later.

  Throws

  Throwing in the handler will terminate the process with an error.

  Note: This function should aim to complete in under 5 seconds to avoid exceeding limits in serverless environments.