Class StorageService<C>

Type parameters

C: Controller = Controller

Hierarchy

Service<C>
- StorageService
  - WebStorageService
  - EphemeralStorageService

Index

Constructors

constructor

Properties

Accessors

attached

Constructors

constructor

new StorageService<C>(): StorageService<C>

Inherited from Service.constructor
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:5
Type parameters
- C: Controller<C> = Controller
Returns StorageService<C>

Properties

Optional Readonly observerType

observerType: Class<StorageServiceObserver<C, StorageService<C>>>

Readonly observers

observers: readonly StorageServiceObserver<C, StorageService<C>>[]

Readonly roots

roots: readonly C[]

Accessors

attached

get attached(): boolean

- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:16
Returns boolean

Methods

attachRoot

attachRoot(root: C): void

Inherited from Service.attachRoot
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:8
Parameters
- root: C
Returns void

Abstract clear

clear(): void

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

detachRoot

detachRoot(root: C): void

Inherited from Service.detachRoot
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:12
Parameters
- root: C
Returns void

Protected didAttach

didAttach(): void

Inherited from Service.didAttach
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:19
Returns void

Protected didAttachRoot

didAttachRoot(root: C): void

Inherited from Service.didAttachRoot
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:11
Parameters
- root: C
Returns void

Protected didClear

didClear(): void

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

Protected didDetach

didDetach(): void

Inherited from Service.didDetach
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:22
Returns void

Protected didDetachRoot

didDetachRoot(root: C): void

Inherited from Service.didDetachRoot
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:15
Parameters
- root: C
Returns void

Protected didObserve

didObserve(observer: StorageServiceObserver<C, StorageService<C>>): void

Inherited from Service.didObserve
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:27
Parameters
- observer: StorageServiceObserver<C, StorageService<C>>
Returns void

Protected didSet

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

- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/storage/StorageService.d.ts:10
Parameters
- key: string
- newValue: undefined | string
- oldValue: undefined | string
Returns void

Protected didUnobserve

didUnobserve(observer: StorageServiceObserver<C, StorageService<C>>): void

Inherited from Service.didUnobserve
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:31
Parameters
- observer: StorageServiceObserver<C, StorageService<C>>
Returns void

Protected forEachObserver

forEachObserver<T>(callback: (observer: StorageServiceObserver<C, StorageService<C>>) => void | T): undefined | T

Inherited from Service.forEachObserver
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:32
Type parameters
- T
Parameters
- callback: (observer: StorageServiceObserver<C, StorageService<C>>) => void | T
  - - (observer: StorageServiceObserver<C, StorageService<C>>): void | T
    - Parameters
      - observer: StorageServiceObserver<C, StorageService<C>>
      Returns void | T
Returns undefined | T

Abstract get

get(key: string): undefined | string

- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/storage/StorageService.d.ts:6
Parameters
- key: string
Returns undefined | string

observe

observe(observer: StorageServiceObserver<C, StorageService<C>>): void

Inherited from Service.observe
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:24
Parameters
- observer: StorageServiceObserver<C, StorageService<C>>
Returns void

Protected onAttach

onAttach(): void

Inherited from Service.onAttach
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:18
Returns void

Protected onAttachRoot

onAttachRoot(root: C): void

Inherited from Service.onAttachRoot
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:10
Parameters
- root: C
Returns void

Protected onClear

onClear(): void

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

Protected onDetach

onDetach(): void

Inherited from Service.onDetach
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:21
Returns void

Protected onDetachRoot

onDetachRoot(root: C): void

Inherited from Service.onDetachRoot
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:14
Parameters
- root: C
Returns void

Protected onObserve

onObserve(observer: StorageServiceObserver<C, StorageService<C>>): void

Inherited from Service.onObserve
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:26
Parameters
- observer: StorageServiceObserver<C, StorageService<C>>
Returns void

Protected onSet

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

- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/storage/StorageService.d.ts:9
Parameters
- key: string
- newValue: undefined | string
- oldValue: undefined | string
Returns void

Protected onUnobserve

onUnobserve(observer: StorageServiceObserver<C, StorageService<C>>): void

Inherited from Service.onUnobserve
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:30
Parameters
- observer: StorageServiceObserver<C, StorageService<C>>
Returns void

Abstract set

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

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

unobserve

unobserve(observer: StorageServiceObserver<C, StorageService<C>>): void

Inherited from Service.unobserve
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:28
Parameters
- observer: StorageServiceObserver<C, StorageService<C>>
Returns void

Protected willAttach

willAttach(): void

Inherited from Service.willAttach
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:17
Returns void

Protected willAttachRoot

willAttachRoot(root: C): void

Inherited from Service.willAttachRoot
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:9
Parameters
- root: C
Returns void

Protected willClear

willClear(): void

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

Protected willDetach

willDetach(): void

Inherited from Service.willDetach
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:20
Returns void

Protected willDetachRoot

willDetachRoot(root: C): void

Inherited from Service.willDetachRoot
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:13
Parameters
- root: C
Returns void

Protected willObserve

willObserve(observer: StorageServiceObserver<C, StorageService<C>>): void

Inherited from Service.willObserve
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:25
Parameters
- observer: StorageServiceObserver<C, StorageService<C>>
Returns void

Protected willSet

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

- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/storage/StorageService.d.ts:8
Parameters
- key: string
- newValue: undefined | string
- oldValue: undefined | string
Returns void

Protected willUnobserve

willUnobserve(observer: StorageServiceObserver<C, StorageService<C>>): void

Inherited from Service.willUnobserve
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:29
Parameters
- observer: StorageServiceObserver<C, StorageService<C>>
Returns void

Static global

global<C>(): StorageService<C>

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

Generated using TypeDoc