WebStorageManager | Swim Toolkit

Type parameters

C: Component = Component

Hierarchy

StorageManager<C>
- WebStorageManager

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new WebStorageManager<C>(storage: Storage): WebStorageManager<C>

Overrides StorageManager.constructor
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/storage/WebStorageManager.d.ts:3
Type parameters
- C: Component<C> = Component
Parameters
- storage: Storage
Returns WebStorageManager<C>

Properties

Readonly componentManagerObservers

componentManagerObservers: readonly StorageManagerObserver<Component, StorageManager<Component>>[]

Readonly rootComponents

rootComponents: readonly C[]

Readonly storage

storage: Storage

Methods

addComponentManagerObserver

addComponentManagerObserver(componentManagerObserver: StorageManagerObserver<Component, StorageManager<Component>>): void

Inherited from StorageManager.addComponentManagerObserver
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/manager/ComponentManager.d.ts:6
Parameters
- componentManagerObserver: StorageManagerObserver<Component, StorageManager<Component>>
Returns void

Protected attachEvents

attachEvents(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/storage/WebStorageManager.d.ts:12
Returns void

clear

clear(): void

Overrides StorageManager.clear
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/storage/WebStorageManager.d.ts:8
Returns void

Protected detachEvents

detachEvents(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/storage/WebStorageManager.d.ts:13
Returns void

Protected didAddComponentManagerObserver

didAddComponentManagerObserver(componentManagerObserver: StorageManagerObserver<Component, StorageManager<Component>>): void

Inherited from StorageManager.didAddComponentManagerObserver
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/manager/ComponentManager.d.ts:9
Parameters
- componentManagerObserver: StorageManagerObserver<Component, StorageManager<Component>>
Returns void

Protected didAttach

didAttach(): void

Inherited from StorageManager.didAttach
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/manager/ComponentManager.d.ts:19
Returns void

Protected didClear

didClear(): void

Inherited from StorageManager.didClear
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/storage/StorageManager.d.ts:13
Returns void

Protected didDetach

didDetach(): void

Inherited from StorageManager.didDetach
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/manager/ComponentManager.d.ts:22
Returns void

Protected didInsertRootComponent

didInsertRootComponent(rootComponent: C): void

Inherited from StorageManager.didInsertRootComponent
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/manager/ComponentManager.d.ts:27
Parameters
- rootComponent: C
Returns void

Protected didObserve

didObserve<T>(callback: (componentManagerObserver: StorageManagerObserver<Component, StorageManager<Component>>) => void | T): undefined | T

Inherited from StorageManager.didObserve
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/manager/ComponentManager.d.ts:15
Type parameters
- T
Parameters
- callback: (componentManagerObserver: StorageManagerObserver<Component, StorageManager<Component>>) => void | T
  - - (componentManagerObserver: StorageManagerObserver<Component, StorageManager<Component>>): void | T
    - Parameters
      - componentManagerObserver: StorageManagerObserver<Component, StorageManager<Component>>
      Returns void | T
Returns undefined | T

Protected didRemoveComponentManagerObserver

didRemoveComponentManagerObserver(componentManagerObserver: StorageManagerObserver<Component, StorageManager<Component>>): void

Inherited from StorageManager.didRemoveComponentManagerObserver
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/manager/ComponentManager.d.ts:13
Parameters
- componentManagerObserver: StorageManagerObserver<Component, StorageManager<Component>>
Returns void

Protected didRemoveRootComponent

didRemoveRootComponent(rootComponent: C): void

Inherited from StorageManager.didRemoveRootComponent
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/manager/ComponentManager.d.ts:31
Parameters
- rootComponent: C
Returns void

Protected didSet

didSet(key: string, newValue: undefined | string, oldValue: undefined | string): void

Inherited from StorageManager.didSet
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/storage/StorageManager.d.ts:9
Parameters
- key: string
- newValue: undefined | string
- oldValue: undefined | string
Returns void

get

get(key: string): undefined | string

Overrides StorageManager.get
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/storage/WebStorageManager.d.ts:6
Parameters
- key: string
Returns undefined | string

insertRootComponent

insertRootComponent(rootComponent: C): void

Inherited from StorageManager.insertRootComponent
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/manager/ComponentManager.d.ts:24
Parameters
- rootComponent: C
Returns void

isAttached

isAttached(): boolean

Inherited from StorageManager.isAttached
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/manager/ComponentManager.d.ts:16
Returns boolean

Protected onAddComponentManagerObserver

onAddComponentManagerObserver(componentManagerObserver: StorageManagerObserver<Component, StorageManager<Component>>): void

Inherited from StorageManager.onAddComponentManagerObserver
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/manager/ComponentManager.d.ts:8
Parameters
- componentManagerObserver: StorageManagerObserver<Component, StorageManager<Component>>
Returns void

Protected onAttach

onAttach(): void

Overrides StorageManager.onAttach
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/storage/WebStorageManager.d.ts:10
Returns void

Protected onClear

onClear(): void

Inherited from StorageManager.onClear
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/storage/StorageManager.d.ts:12
Returns void

Protected onDetach

onDetach(): void

Overrides StorageManager.onDetach
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/storage/WebStorageManager.d.ts:11
Returns void

Protected onInsertRootComponent

onInsertRootComponent(rootComponent: C): void

Inherited from StorageManager.onInsertRootComponent
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/manager/ComponentManager.d.ts:26
Parameters
- rootComponent: C
Returns void

Protected onRemoveComponentManagerObserver

onRemoveComponentManagerObserver(componentManagerObserver: StorageManagerObserver<Component, StorageManager<Component>>): void

Inherited from StorageManager.onRemoveComponentManagerObserver
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/manager/ComponentManager.d.ts:12
Parameters
- componentManagerObserver: StorageManagerObserver<Component, StorageManager<Component>>
Returns void

Protected onRemoveRootComponent

onRemoveRootComponent(rootComponent: C): void

Inherited from StorageManager.onRemoveRootComponent
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/manager/ComponentManager.d.ts:30
Parameters
- rootComponent: C
Returns void

Protected onSet

onSet(key: string, newValue: undefined | string, oldValue: undefined | string): void

Inherited from StorageManager.onSet
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/storage/StorageManager.d.ts:8
Parameters
- key: string
- newValue: undefined | string
- oldValue: undefined | string
Returns void

onStorage

onStorage(event: StorageEvent): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/storage/WebStorageManager.d.ts:9
Parameters
- event: StorageEvent
Returns void

removeComponentManagerObserver

removeComponentManagerObserver(componentManagerObserver: StorageManagerObserver<Component, StorageManager<Component>>): void

Inherited from StorageManager.removeComponentManagerObserver
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/manager/ComponentManager.d.ts:10
Parameters
- componentManagerObserver: StorageManagerObserver<Component, StorageManager<Component>>
Returns void

removeRootComponent

removeRootComponent(rootComponent: C): void

Inherited from StorageManager.removeRootComponent
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/manager/ComponentManager.d.ts:28
Parameters
- rootComponent: C
Returns void

set

set(key: string, newValue: undefined | string): undefined | string

Overrides StorageManager.set
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/storage/WebStorageManager.d.ts:7
Parameters
- key: string
- newValue: undefined | string
Returns undefined | string

Protected willAddComponentManagerObserver

willAddComponentManagerObserver(componentManagerObserver: StorageManagerObserver<Component, StorageManager<Component>>): void

Inherited from StorageManager.willAddComponentManagerObserver
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/manager/ComponentManager.d.ts:7
Parameters
- componentManagerObserver: StorageManagerObserver<Component, StorageManager<Component>>
Returns void

Protected willAttach

willAttach(): void

Inherited from StorageManager.willAttach
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/manager/ComponentManager.d.ts:17
Returns void

Protected willClear

willClear(): void

Inherited from StorageManager.willClear
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/storage/StorageManager.d.ts:11
Returns void

Protected willDetach

willDetach(): void

Inherited from StorageManager.willDetach
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/manager/ComponentManager.d.ts:20
Returns void

Protected willInsertRootComponent

willInsertRootComponent(rootComponent: C): void

Inherited from StorageManager.willInsertRootComponent
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/manager/ComponentManager.d.ts:25
Parameters
- rootComponent: C
Returns void

Protected willObserve

willObserve<T>(callback: (componentManagerObserver: StorageManagerObserver<Component, StorageManager<Component>>) => void | T): undefined | T

Inherited from StorageManager.willObserve
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/manager/ComponentManager.d.ts:14
Type parameters
- T
Parameters
- callback: (componentManagerObserver: StorageManagerObserver<Component, StorageManager<Component>>) => void | T
  - - (componentManagerObserver: StorageManagerObserver<Component, StorageManager<Component>>): void | T
    - Parameters
      - componentManagerObserver: StorageManagerObserver<Component, StorageManager<Component>>
      Returns void | T
Returns undefined | T

Protected willRemoveComponentManagerObserver

willRemoveComponentManagerObserver(componentManagerObserver: StorageManagerObserver<Component, StorageManager<Component>>): void

Inherited from StorageManager.willRemoveComponentManagerObserver
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/manager/ComponentManager.d.ts:11
Parameters
- componentManagerObserver: StorageManagerObserver<Component, StorageManager<Component>>
Returns void

Protected willRemoveRootComponent

willRemoveRootComponent(rootComponent: C): void

Inherited from StorageManager.willRemoveRootComponent
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/manager/ComponentManager.d.ts:29
Parameters
- rootComponent: C
Returns void

Protected willSet

willSet(key: string, newValue: undefined | string, oldValue: undefined | string): void

Inherited from StorageManager.willSet
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/storage/StorageManager.d.ts:7
Parameters
- key: string
- newValue: undefined | string
- oldValue: undefined | string
Returns void

Static local

local<C>(): null | WebStorageManager<C>

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/storage/WebStorageManager.d.ts:14
Type parameters
- C: Component<C>
Returns null | WebStorageManager<C>

Static session

session<C>(): null | WebStorageManager<C>

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/storage/WebStorageManager.d.ts:15
Type parameters
- C: Component<C>
Returns null | WebStorageManager<C>

Type parameters

C: Component = Component

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type parameters

C: Component<C> = Component

Parameters

storage: Storage

Returns WebStorageManager<C>

Properties

Readonly componentManagerObservers

Readonly rootComponents

Readonly storage

Methods

addComponentManagerObserver

Parameters

componentManagerObserver: StorageManagerObserver<Component, StorageManager<Component>>

Returns void

Protected attachEvents

Returns void

clear

Returns void

Protected detachEvents

Returns void

Protected didAddComponentManagerObserver

Parameters

componentManagerObserver: StorageManagerObserver<Component, StorageManager<Component>>

Returns void

Protected didAttach

Returns void

Protected didClear

Returns void

Protected didDetach

Returns void

Protected didInsertRootComponent

Parameters

rootComponent: C

Returns void

Protected didObserve

Type parameters

T

Parameters

callback: (componentManagerObserver: StorageManagerObserver<Component, StorageManager<Component>>) => void | T

Parameters

componentManagerObserver: StorageManagerObserver<Component, StorageManager<Component>>

Returns void | T

Returns undefined | T

Protected didRemoveComponentManagerObserver

Parameters

componentManagerObserver: StorageManagerObserver<Component, StorageManager<Component>>

Returns void

Protected didRemoveRootComponent

Parameters

rootComponent: C

Returns void

Protected didSet

Parameters

key: string

newValue: undefined | string

oldValue: undefined | string

Returns void

get

Parameters

key: string

Returns undefined | string

insertRootComponent

Parameters

rootComponent: C

Returns void

isAttached

Returns boolean

Protected onAddComponentManagerObserver

Parameters

componentManagerObserver: StorageManagerObserver<Component, StorageManager<Component>>

Returns void