Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DataService

Hierarchy

  • DataService

Index

Constructors

Properties

Methods

Constructors

constructor

  • new DataService(store: default, data?: any): DataService

Properties

lastUpdate

lastUpdate: {} = ...

internal value to track previous data

Type declaration

observers

observers: {} = ...

current observers on json-pointer changes

Type declaration

  • [pointer: string]: Observer[]

store

store: default

current state

watcher

watcher: any[] = ...

list of active watchers on update-lifecycle events

Methods

bubbleObservers

  • bubbleObservers(pointer: string, event: UpdateDataEvent): void

delete

  • delete(pointer: string): void

destroy

  • destroy(): void

get

  • get(pointer?: string): any

getDataByReference

  • getDataByReference(pointer?: string): any

  • returns a reference to data from the requested pointer (cheaper)

    Parameters

    • pointer: string = "#"

    Returns any

    data, associated with pointer

isValid

  • isValid(pointer: string): boolean

notify

  • notify(pointer: string, event: UpdateDataEvent): void

notifyWatcher

  • notifyWatcher(event: Event): void

observe

  • observe<T>(pointer: string, callback: T, bubbleEvents?: boolean): T

  • observes changes in data at the specified json-pointer

    Type parameters

    • T: Observer

    Parameters

    • pointer: string

      json-pointer to watch

    • callback: T

      called on a change

    • bubbleEvents: boolean = false

      set to true to receive notifications changes in children of pointer

    Returns T

    callback

onStateChanged

  • onStateChanged(): void

redo

  • redo(): void

redoCount

  • redoCount(): number

removeObserver

  • removeObserver(pointer: string, callback: Observer): DataService

removeWatcher

  • removeWatcher(callback: Watcher): void

resetUndoRedo

  • resetUndoRedo(): void

set

  • set(pointer: string, value: any, options?: { addToHistory?: boolean }): void

  • Change data at the given pointer

    Parameters

    • pointer: string

      data location to modify

    • value: any

      new value at pointer

    • Optional options: { addToHistory?: boolean }
      • Optional addToHistory?: boolean

    Returns void

undo

  • undo(): void

undoCount

  • undoCount(): number

watch

  • watch(callback: Watcher): Watcher

Generated using TypeDoc