Class Notifier

Hierarchy

Notifier
Hierarchy

Index

Constructors

Properties

_interval _memory _size _timer? handlers name

Methods

check log notify on recall start stop

Constructors

constructor

new Notifier(storage?: News[], size?: number, interval?: number): Notifier
Create a new Notifier instance.
Parameters
- Optional storage: News[]
  
  A reference to the News memory array.
- size: number = DEFAULT_MEM_SIZE
  
  The maximum number of news to keep in memory.
- interval: number = DEFAULT_INTERVAL
  
  The interval in milliseconds to check for new news.
Returns Notifier
- Defined in notifier.ts:31

Properties

`Protected` _interval

_interval: number

`Protected` _memory

_memory: News[] = []

`Protected` _size

_size: number

`Protected` `Optional` _timer

_timer?: Timer

handlers

handlers: NotifierHandlerSet = ...

name

name: string = ""

Methods

`Private` check

check(): Promise<News[]>
Returns Promise<News[]>
- Defined in notifier.ts:80

`Protected` log

log(...data: unknown[]): void
Parameters
- Rest ...data: unknown[]
Returns void
- Defined in notifier.ts:101

`Private` notify

notify(news: News): Promise<void>
Parameters
- news: News
Returns Promise<void>
- Defined in notifier.ts:97

on

on(event: "init", handler: Initialize): Notifier
Parameters
- event: "init"
- handler: Initialize
Returns Notifier
- Defined in notifier.ts:63
on(event: "check", handler: Check): Notifier
Parameters
- event: "check"
- handler: Check
Returns Notifier
- Defined in notifier.ts:64
on(event: "notify", handler: Notify): Notifier
Parameters
- event: "notify"
- handler: Notify
Returns Notifier
- Defined in notifier.ts:65
on(event: "first", handler: FirstShot): Notifier
Parameters
- event: "first"
- handler: FirstShot
Returns Notifier
- Defined in notifier.ts:66

recall

recall(news: News[]): Notifier
Add a news item to the memory array. Notify triggers will not be fired.
Parameters
- news: News[]
  
  List of news to add to the memory.
Returns Notifier
- Defined in notifier.ts:58

start

start(): Promise<News[]>
Returns Promise<News[]>
- Defined in notifier.ts:39

stop

stop(): void
Returns void
- Defined in notifier.ts:47

Generated using TypeDoc