Class Alert

Represents an alert aggregate with breach details and lifecycle operations.

Param: id

The alert identifier.

Param: details

The breach details associated with the alert.

Param: createdAt

The timestamp when the alert was created.

Param: _status

The current delivery status of the alert.

Param: _sentAt

The timestamp when the alert was sent, if any.

Param: _failReason

The failure reason when sending fails, if any.

Param: _readAt

The timestamp when the alert was read, if any.

Index

Properties

createdAt details id

Accessors

failReason isRead readAt sentAt status

Methods

markAsFailed markAsRead markAsSent create restore

Properties

`Readonly`createdAt

createdAt: Date

`Readonly`details

details: BreachDetails

`Readonly`id

Accessors

failReason

get failReason(): string | undefined
Returns string | undefined
- Defined in src/domain/Alert.ts:92

isRead

get isRead(): boolean
Returns boolean
- Defined in src/domain/Alert.ts:98

readAt

get readAt(): Date | undefined
Returns Date | undefined
- Defined in src/domain/Alert.ts:95

sentAt

get sentAt(): Date | undefined
Returns Date | undefined
- Defined in src/domain/Alert.ts:89

status

get status(): AlertStatus
Returns AlertStatus
- Defined in src/domain/Alert.ts:86

Methods

markAsFailed

markAsFailed(reason: string): void
Parameters
- reason: string
Returns void
- Defined in src/domain/Alert.ts:76

markAsRead

markAsRead(): void
Returns void
- Defined in src/domain/Alert.ts:81

markAsSent

markAsSent(): void
Returns void
- Defined in src/domain/Alert.ts:69

`Static`create

create(details: BreachDetails): Alert
Parameters
- details: BreachDetails
Returns Alert
- Defined in src/domain/Alert.ts:28

`Static`restore

restore(
    id: AlertId,
    details: BreachDetails,
    createdAt: string | Date,
    status: AlertStatus,
    sentAt?: string | Date,
    failReason?: string,
    readAt?: string | Date,
): Alert
Parameters
- id: AlertId
- details: BreachDetails
- createdAt: string | Date
- status: AlertStatus
- OptionalsentAt: string | Date
- OptionalfailReason: string
- OptionalreadAt: string | Date
Returns Alert
- Defined in src/domain/Alert.ts:38