Class AlertContext

Price alert management context.

Index

Constructors

Methods

new list add update delete

Constructors

constructor

new AlertContext(): AlertContext
Returns AlertContext

Methods

`Static`new

new(config: Config): AlertContext
Create a new AlertContext.
Parameters
- config: Config
Returns AlertContext

list

list(): Promise<AlertList>
List all price alerts.

Returns Promise<AlertList>

add

add(
    symbol: string,
    condition: AlertCondition,
    triggerValue: string,
    frequency: AlertFrequency,
): Promise<void>
Add a price alert for a security.

triggerValue is a price or percentage string depending on condition.
Parameters
- symbol: string
- condition: AlertCondition
- triggerValue: string
- frequency: AlertFrequency
Returns Promise<void>

update

update(item: AlertItem): Promise<void>
Update a price alert.

Pass the [AlertItem] obtained from list. Set item.enabled to true to re-enable or false to disable before calling this method.
Parameters
- item: AlertItem
Returns Promise<void>

delete

delete(alertIds: string[]): Promise<void>
Delete one or more price alerts by ID.
Parameters
- alertIds: string[]
Returns Promise<void>