Type Alias HotMeshWorker

Type declaration

• callback: ((payload: StreamData) => Promise<StreamDataResponse>)

  The callback function to execute when a message is dequeued from the target stream

  • • (payload): Promise<StreamDataResponse>

    • Parameters

      • payload: StreamData

      Returns Promise<StreamDataResponse>

• Optionalconnection?: ProviderConfig | ProvidersConfig

  short-form format for the connection options for the store, stream, sub, and search clients

• OptionalreclaimCount?: number

  the number of times to reclaim a stream before giving up and moving the message to a dead-letter queue or other error handling mechanism

• OptionalreclaimDelay?: number

  the number of milliseconds to wait before reclaiming a stream; depending upon the provider this may be an explicit retry event, consuming a message from the stream and re-queueing it (dlq, etc), or it may be a configurable delay before the provider exposes the message to the consumer again. It is up to the provider, but expressed in milliseconds here.

• OptionalretryPolicy?: types/stream

  Retry policy for stream messages. Configures automatic retry behavior with exponential backoff for failed operations. Applied to the stream connection during initialization.

  Example

  {
    retryPolicy: {
      maximumAttempts: 5,
      backoffCoefficient: 2,
      maximumInterval: '300s'
    }
  }
  Copy

• OptionaltaskQueue?: string

  Task queue identifier used for connection pooling optimization. When provided, connections will be reused across providers (store, sub, stream) that share the same task queue and database configuration.

• topic: string

  the topic/task queue that the worker subscribes to (stream_name)

• OptionalworkflowName?: string

  the workflow function name for dispatch routing (workflow_name column). When set, workers sharing the same topic use a singleton consumer that fetches batches and dispatches by workflowName.