WebStorageManager | Swim Toolkit

Type parameters

C: Controller = Controller

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/controller/lib/main/storage/WebStorageManager.d.ts:4
Type parameters
- C: Controller<C> = Controller
Parameters
- storage: Storage
Returns WebStorageManager<C>

Properties

Readonly controllerManagerObservers

controllerManagerObservers: readonly StorageManagerObserver<Controller, StorageManager<Controller>>[]

Readonly rootControllers

rootControllers: readonly C[]

Readonly storage

storage: Storage

Methods

addControllerManagerObserver

addControllerManagerObserver(controllerManagerObserver: StorageManagerObserver<Controller, StorageManager<Controller>>): void

Inherited from StorageManager.addControllerManagerObserver
- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/manager/ControllerManager.d.ts:6
Parameters
- controllerManagerObserver: StorageManagerObserver<Controller, StorageManager<Controller>>
Returns void

Protected attachEvents

attachEvents(): void

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

clear

clear(): void

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

Protected detachEvents

detachEvents(): void

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

Protected didAddControllerManagerObserver

didAddControllerManagerObserver(controllerManagerObserver: StorageManagerObserver<Controller, StorageManager<Controller>>): void

Inherited from StorageManager.didAddControllerManagerObserver
- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/manager/ControllerManager.d.ts:9
Parameters
- controllerManagerObserver: StorageManagerObserver<Controller, StorageManager<Controller>>
Returns void

Protected didAttach

didAttach(): void

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

Protected didClear

didClear(): void

Inherited from StorageManager.didClear
- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/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/controller/lib/main/manager/ControllerManager.d.ts:22
Returns void

Protected didInsertRootController

didInsertRootController(rootController: C): void

Inherited from StorageManager.didInsertRootController
- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/manager/ControllerManager.d.ts:27
Parameters
- rootController: C
Returns void

Protected didObserve

didObserve<T>(callback: (controllerManagerObserver: StorageManagerObserver<Controller, StorageManager<Controller>>) => void | T): undefined | T

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

Protected didRemoveControllerManagerObserver

didRemoveControllerManagerObserver(controllerManagerObserver: StorageManagerObserver<Controller, StorageManager<Controller>>): void

Inherited from StorageManager.didRemoveControllerManagerObserver
- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/manager/ControllerManager.d.ts:13
Parameters
- controllerManagerObserver: StorageManagerObserver<Controller, StorageManager<Controller>>
Returns void

Protected didRemoveRootController

didRemoveRootController(rootController: C): void

Inherited from StorageManager.didRemoveRootController
- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/manager/ControllerManager.d.ts:31
Parameters
- rootController: 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/controller/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/controller/lib/main/storage/WebStorageManager.d.ts:6
Parameters
- key: string
Returns undefined | string

insertRootController

insertRootController(rootController: C): void

Inherited from StorageManager.insertRootController
- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/manager/ControllerManager.d.ts:24
Parameters
- rootController: C
Returns void

isAttached

isAttached(): boolean

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

Protected onAddControllerManagerObserver

onAddControllerManagerObserver(controllerManagerObserver: StorageManagerObserver<Controller, StorageManager<Controller>>): void

Inherited from StorageManager.onAddControllerManagerObserver
- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/manager/ControllerManager.d.ts:8
Parameters
- controllerManagerObserver: StorageManagerObserver<Controller, StorageManager<Controller>>
Returns void

Protected onAttach

onAttach(): void

Overrides StorageManager.onAttach
- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/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/controller/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/controller/lib/main/storage/WebStorageManager.d.ts:11
Returns void

Protected onInsertRootController

onInsertRootController(rootController: C): void

Inherited from StorageManager.onInsertRootController
- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/manager/ControllerManager.d.ts:26
Parameters
- rootController: C
Returns void

Protected onRemoveControllerManagerObserver

onRemoveControllerManagerObserver(controllerManagerObserver: StorageManagerObserver<Controller, StorageManager<Controller>>): void

Inherited from StorageManager.onRemoveControllerManagerObserver
- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/manager/ControllerManager.d.ts:12
Parameters
- controllerManagerObserver: StorageManagerObserver<Controller, StorageManager<Controller>>
Returns void

Protected onRemoveRootController

onRemoveRootController(rootController: C): void

Inherited from StorageManager.onRemoveRootController
- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/manager/ControllerManager.d.ts:30
Parameters
- rootController: 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/controller/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/controller/lib/main/storage/WebStorageManager.d.ts:9
Parameters
- event: StorageEvent
Returns void

removeControllerManagerObserver

removeControllerManagerObserver(controllerManagerObserver: StorageManagerObserver<Controller, StorageManager<Controller>>): void

Inherited from StorageManager.removeControllerManagerObserver
- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/manager/ControllerManager.d.ts:10
Parameters
- controllerManagerObserver: StorageManagerObserver<Controller, StorageManager<Controller>>
Returns void

removeRootController

removeRootController(rootController: C): void

Inherited from StorageManager.removeRootController
- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/manager/ControllerManager.d.ts:28
Parameters
- rootController: C
Returns void

set

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

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

Protected willAddControllerManagerObserver

willAddControllerManagerObserver(controllerManagerObserver: StorageManagerObserver<Controller, StorageManager<Controller>>): void

Inherited from StorageManager.willAddControllerManagerObserver
- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/manager/ControllerManager.d.ts:7
Parameters
- controllerManagerObserver: StorageManagerObserver<Controller, StorageManager<Controller>>
Returns void

Protected willAttach

willAttach(): void

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

Protected willClear

willClear(): void

Inherited from StorageManager.willClear
- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/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/controller/lib/main/manager/ControllerManager.d.ts:20
Returns void

Protected willInsertRootController

willInsertRootController(rootController: C): void

Inherited from StorageManager.willInsertRootController
- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/manager/ControllerManager.d.ts:25
Parameters
- rootController: C
Returns void

Protected willObserve

willObserve<T>(callback: (controllerManagerObserver: StorageManagerObserver<Controller, StorageManager<Controller>>) => void | T): undefined | T

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

Protected willRemoveControllerManagerObserver

willRemoveControllerManagerObserver(controllerManagerObserver: StorageManagerObserver<Controller, StorageManager<Controller>>): void

Inherited from StorageManager.willRemoveControllerManagerObserver
- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/manager/ControllerManager.d.ts:11
Parameters
- controllerManagerObserver: StorageManagerObserver<Controller, StorageManager<Controller>>
Returns void

Protected willRemoveRootController

willRemoveRootController(rootController: C): void

Inherited from StorageManager.willRemoveRootController
- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/manager/ControllerManager.d.ts:29
Parameters
- rootController: 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/controller/lib/main/storage/StorageManager.d.ts:7
Parameters
- key: string
- newValue: undefined | string
- oldValue: undefined | string
Returns void

Static global

global<C>(): StorageManager<C>

Inherited from StorageManager.global
- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/storage/StorageManager.d.ts:15
Type parameters
- C: Controller<C>
Returns StorageManager<C>

Static local

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

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

Static session

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

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

Type parameters

C: Controller = Controller

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type parameters

C: Controller<C> = Controller

Parameters

storage: Storage

Returns WebStorageManager<C>

Properties

Readonly controllerManagerObservers

Readonly rootControllers

Readonly storage

Methods

addControllerManagerObserver

Parameters

controllerManagerObserver: StorageManagerObserver<Controller, StorageManager<Controller>>

Returns void

Protected attachEvents

Returns void

clear

Returns void

Protected detachEvents

Returns void

Protected didAddControllerManagerObserver

Parameters

controllerManagerObserver: StorageManagerObserver<Controller, StorageManager<Controller>>

Returns void

Protected didAttach

Returns void

Protected didClear

Returns void

Protected didDetach

Returns void

Protected didInsertRootController

Parameters

rootController: C

Returns void

Protected didObserve

Type parameters

T

Parameters

callback: (controllerManagerObserver: StorageManagerObserver<Controller, StorageManager<Controller>>) => void | T

Parameters

controllerManagerObserver: StorageManagerObserver<Controller, StorageManager<Controller>>

Returns void | T

Returns undefined | T

Protected didRemoveControllerManagerObserver

Parameters

controllerManagerObserver: StorageManagerObserver<Controller, StorageManager<Controller>>

Returns void

Protected didRemoveRootController

Parameters

rootController: C

Returns void

Protected didSet

Parameters

key: string

newValue: undefined | string

oldValue: undefined | string

Returns void

get

Parameters

key: string

Returns undefined | string

insertRootController

Parameters

rootController: C

Returns void

isAttached

Returns boolean

Protected onAddControllerManagerObserver

Parameters

controllerManagerObserver: StorageManagerObserver<Controller, StorageManager<Controller>>

Returns void