Interface Subject

Readonlydisplay

pollRate

add

• add(ids: string[]): Promise<void>

• Add records to observe.

  Parameters

  • ids: string[]

    The ids to add.

  Returns Promise<void>

get

• get(id: string | HRef): undefined | HDict

• Return a record via its id or undefined if it can't be found.

  Parameters

  • id: string | HRef

    The id to record to get.

  Returns undefined | HDict

  The dict or undefined if it can't be found.

inspect

• inspect(): void

• Inspect the subject.

  Returns void

off

• off(callback: SubjectChangedEventHandler): void

• Unregister the callback for changed events.

  Parameters

  • callback: SubjectChangedEventHandler

    The callback used for changed events.

  Returns void

on

• on(callback: SubjectChangedEventHandler): void

• Register a callback for changed events.

  Parameters

  • callback: SubjectChangedEventHandler

    The callback used for changed events.

  Returns void

poll

• poll(): Promise<void>

• Request a watch poll.

  Returns Promise<void>

refresh

• refresh(): Promise<void>

• Refresh the subject's data.

  Returns Promise<void>

remove

• remove(ids: string[]): Promise<void>

• Remove records from the subject.

  This is called to stop observing records.

  Parameters

  • ids: string[]

    The ids to remove.

  Returns Promise<void>

update

• update(grid: HGrid): Promise<void>

• Used to manually trigger a watch update.

  Parameters

  • grid: HGrid

    A grid of dicts to update.

  Returns Promise<void>