Class WatchlistRepository

Named symbol lists with serialized, revision-checked writes. Each change is applied to the catalog as stored at that moment, so an edit made in another session survives; only a write racing it is refused, as a conflict. Create a new repository when the account changes.

Implements

WatchlistStore

Index

Constructors

constructor

new WatchlistRepository(
    storage: WatchlistStorage,
    namespace: string,
    options?: WatchlistRepositoryOptions,
): WatchlistRepository
Parameters
- storage: WatchlistStorage
- namespace: string
- options: WatchlistRepositoryOptions = {}
Returns WatchlistRepository
- Defined in src/workspace/watchlists.ts:129

Accessors

namespace

get namespace(): string
Returns string
- Defined in src/workspace/watchlists.ts:135

Methods

addEntry

addEntry(
    id: string,
    entry: InstrumentKey,
    options?: WatchlistOperationOptions & { index?: number },
): Promise<Watchlist>
Parameters
- id: string
- entry: InstrumentKey
- options: WatchlistOperationOptions & { index?: number } = {}
Returns Promise<Watchlist>
Implementation of WatchlistStore.addEntry
- Defined in src/workspace/watchlists.ts:180

createList

createList(
    name: string,
    entries?: readonly InstrumentKey[],
    options?: WatchlistOperationOptions,
): Promise<Watchlist>
Parameters
- name: string
- entries: readonly InstrumentKey[] = []
- Optionaloptions: WatchlistOperationOptions
Returns Promise<Watchlist>
Implementation of WatchlistStore.createList
- Defined in src/workspace/watchlists.ts:141

duplicateList

duplicateList(
    id: string,
    name: string,
    options?: WatchlistOperationOptions,
): Promise<Watchlist>
Parameters
- id: string
- name: string
- Optionaloptions: WatchlistOperationOptions
Returns Promise<Watchlist>
- Defined in src/workspace/watchlists.ts:157

load

load(): Promise<WatchlistCatalog>
Returns Promise<WatchlistCatalog>
Implementation of WatchlistStore.load
- Defined in src/workspace/watchlists.ts:137

moveEntry

moveEntry(
    id: string,
    entry: InstrumentKey,
    index: number,
    options?: WatchlistOperationOptions,
): Promise<Watchlist>
Parameters
- id: string
- entry: InstrumentKey
- index: number
- Optionaloptions: WatchlistOperationOptions
Returns Promise<Watchlist>
Implementation of WatchlistStore.moveEntry
- Defined in src/workspace/watchlists.ts:197

removeEntry

removeEntry(
    id: string,
    entry: InstrumentKey,
    options?: WatchlistOperationOptions,
): Promise<Watchlist>
Parameters
- id: string
- entry: InstrumentKey
- Optionaloptions: WatchlistOperationOptions
Returns Promise<Watchlist>
Implementation of WatchlistStore.removeEntry
- Defined in src/workspace/watchlists.ts:190

removeList

removeList(id: string, options?: WatchlistOperationOptions): Promise<void>
Parameters
- id: string
- Optionaloptions: WatchlistOperationOptions
Returns Promise<void>
Implementation of WatchlistStore.removeList
- Defined in src/workspace/watchlists.ts:168

renameList

renameList(
    id: string,
    name: string,
    options?: WatchlistOperationOptions,
): Promise<Watchlist>
Parameters
- id: string
- name: string
- Optionaloptions: WatchlistOperationOptions
Returns Promise<Watchlist>
Implementation of WatchlistStore.renameList
- Defined in src/workspace/watchlists.ts:152

setActiveList

setActiveList(
id: null | string,
options?: WatchlistOperationOptions,
): Promise<void>
Parameters
- id: null | string
- Optionaloptions: WatchlistOperationOptions
Returns Promise<void>
Implementation of WatchlistStore.setActiveList
- Defined in src/workspace/watchlists.ts:176

subscribe(listener: (catalog: WatchlistCatalog) => void): () => void
Called after each change this store commits, before that change's promise resolves, as WatchlistRepository does: the panel computes a following move from the catalog delivered here. Returns the unsubscribe.
Parameters
- listener: (catalog: WatchlistCatalog) => void
Returns () => void
Implementation of WatchlistStore.subscribe
- Defined in src/workspace/watchlists.ts:139

Class WatchlistRepository

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns WatchlistRepository

Accessors

namespace

Returns string

Methods

addEntry

Parameters

Returns Promise<Watchlist>

createList

Parameters

Returns Promise<Watchlist>

duplicateList

Parameters

Returns Promise<Watchlist>

load

Returns Promise<WatchlistCatalog>

moveEntry

Parameters

Returns Promise<Watchlist>

removeEntry

Parameters

Returns Promise<Watchlist>

removeList

Parameters

Returns Promise<void>

renameList

Parameters

Returns Promise<Watchlist>

setActiveList

Parameters

Returns Promise<void>

subscribe

Parameters

Returns () => void

Settings

On This Page