Class BaseNotificationChannel`Abstract`

Abstract base class for notification channels. Provides common functionality like state management and reconnection logic.

Hierarchy (View Summary)

EventEmitter
- BaseNotificationChannel
  - InMemoryNotificationChannel

Implements

NotificationChannel

Index

Constructors

Properties

_state config handlers reconnectAttempts reconnectTimeout? stateHandlers

Accessors

Methods

clearReconnect connect disconnect notifyHandlers notifyStateHandlers publish scheduleReconnect setState subscribe subscribeState

Constructors

constructor

new BaseNotificationChannel(
config?: NotificationChannelConfig,
): BaseNotificationChannel
Parameters
- config: NotificationChannelConfig = {}
Returns BaseNotificationChannel
Overrides EventEmitter.constructor
- Defined in notifications/BaseNotificationChannel.ts:38

Properties

`Protected`_state

_state: NotificationChannelState = 'disconnected'

`Protected` `Readonly`config

config: ResolvedNotificationChannelConfig

`Protected`handlers

handlers: Set<NotificationHandler> = ...

`Protected`reconnectAttempts

reconnectAttempts: number = 0

`Protected` `Optional`reconnectTimeout

reconnectTimeout?: Timeout

`Protected`stateHandlers

stateHandlers: Set<StateNotificationHandler> = ...

Accessors

state

get state(): NotificationChannelState
Current state of the channel

Returns NotificationChannelState
Implementation of NotificationChannel.state
- Defined in notifications/BaseNotificationChannel.ts:51

Methods

`Protected`clearReconnect

clearReconnect(): void
Returns void
- Defined in notifications/BaseNotificationChannel.ts:144

`Abstract`connect

connect(): Promise<void>
Connect to the notification backend

Returns Promise<void>
Implementation of NotificationChannel.connect
- Defined in notifications/BaseNotificationChannel.ts:62

`Abstract`disconnect

disconnect(): Promise<void>
Disconnect from the notification backend

Returns Promise<void>
Implementation of NotificationChannel.disconnect
- Defined in notifications/BaseNotificationChannel.ts:63

`Protected`notifyHandlers

notifyHandlers(notification: JobNotification): Promise<void>
Parameters
- notification: JobNotification
Returns Promise<void>
- Defined in notifications/BaseNotificationChannel.ts:73

`Protected`notifyStateHandlers

notifyStateHandlers(notification: JobStateNotification): Promise<void>
Notify all registered state handlers of a state notification. Subclasses should call this when receiving state notifications.
Parameters
- notification: JobStateNotification
Returns Promise<void>
- Defined in notifications/BaseNotificationChannel.ts:92

`Abstract`publish

publish(notification: JobNotification): Promise<void>
Publish a job notification
Parameters
- notification: JobNotification
  The notification to publish
Returns Promise<void>
Implementation of NotificationChannel.publish
- Defined in notifications/BaseNotificationChannel.ts:64

`Protected`scheduleReconnect

scheduleReconnect(): void
Returns void
- Defined in notifications/BaseNotificationChannel.ts:118

`Protected`setState

setState(newState: NotificationChannelState): void
Parameters
- newState: NotificationChannelState
Returns void
- Defined in notifications/BaseNotificationChannel.ts:55

subscribe(handler: NotificationHandler): () => void
Subscribe to job notifications
Parameters
- handler: NotificationHandler
  Function to call when a notification is received
Returns () => void
Unsubscribe function
Implementation of NotificationChannel.subscribe
- Defined in notifications/BaseNotificationChannel.ts:66

subscribeState

subscribeState(handler: StateNotificationHandler): () => void
Subscribe to state notifications. Default implementation manages the stateHandlers set.
Parameters
- handler: StateNotificationHandler
Returns () => void
Implementation of NotificationChannel.subscribeState
- Defined in notifications/BaseNotificationChannel.ts:111