Interface NotificationChannel

Readonlystate

connect

• connect(): Promise<void>

  Connect to the notification backend

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Disconnect from the notification backend

  Returns Promise<void>

off

• off(
      event: "stateChange",
      listener: (state: NotificationChannelState) => void,
  ): this

  Remove an event listener

  Parameters

  • event: "stateChange"
  • listener: (state: NotificationChannelState) => void

  Returns this

• off(event: "error", listener: (error: Error) => void): this

  Parameters

  • event: "error"
  • listener: (error: Error) => void

  Returns this

on

• on(
      event: "stateChange",
      listener: (state: NotificationChannelState) => void,
  ): this

  Register an event listener

  Parameters

  • event: "stateChange"
  • listener: (state: NotificationChannelState) => void

  Returns this

• on(event: "error", listener: (error: Error) => void): this

  Parameters

  • event: "error"
  • listener: (error: Error) => void

  Returns this

publish

• publish(notification: JobNotification): Promise<void>

  Publish a job notification

  Parameters

  • notification: JobNotification

    The notification to publish

  Returns Promise<void>

subscribe

• subscribe(handler: NotificationHandler): () => void

  Subscribe to job notifications

  Parameters

  • handler: NotificationHandler

    Function to call when a notification is received

  Returns () => void

  Unsubscribe function