Class AlertService

Coordinates alert creation, delivery, and repository operations.

Param: repository

The persistence implementation for alerts.

Param: sender

The transport responsible for sending alerts.

Index

Constructors

Methods

createAndSend deleteAll deleteOne getAll getById getUnreadCount markAsRead

Constructors

constructor

new AlertService(repository: AlertRepository, sender: AlertSender): AlertService
Parameters
- repository: AlertRepository
- sender: AlertSender
Returns AlertService
- Defined in src/application/AlertService.ts:16

Methods

createAndSend

createAndSend(command: CreateAlertCommand): Promise<AlertId | null>
Creates an alert from the given command, attempts delivery, and persists state.

Applies spam mitigation: If an unread alert for the same threshold exists and was created within the last hour, creation is skipped.
Parameters
- command: CreateAlertCommand
  The data required to create the alert.
Returns Promise<AlertId | null>
The created alert identifier, or null if suppressed.
- Defined in src/application/AlertService.ts:30

deleteAll

deleteAll(): Promise<void>
Returns Promise<void>
- Defined in src/application/AlertService.ts:102

deleteOne

deleteOne(id: string): Promise<void>
Parameters
- id: string
Returns Promise<void>
- Defined in src/application/AlertService.ts:97

getAll

getAll(): Promise<Alert[]>
Returns Promise<Alert[]>
- Defined in src/application/AlertService.ts:83

getById

getById(id: string): Promise<Alert>
Retrieves an alert by its string identifier.
Parameters
- id: string
  The string identifier of the alert.
Returns Promise<Alert>
The Alert instance when found.

Throws
If no alert exists for the provided identifier.
- Defined in src/application/AlertService.ts:75

getUnreadCount

getUnreadCount(): Promise<number>
Returns Promise<number>
- Defined in src/application/AlertService.ts:87

markAsRead

markAsRead(id: string): Promise<void>
Parameters
- id: string
Returns Promise<void>
- Defined in src/application/AlertService.ts:91