Globals / "src/common/base-store" / BaseStore
Class: BaseStore\#
Type parameters#
| Name | Default |
|---|---|
T |
any |
Hierarchy#
↳ BaseStore
↳↳ ClusterStore
↳↳ UserStore
Index#
Constructors#
Properties#
Accessors#
Methods#
- applyWithoutSync
- cwd
- disableSync
- enableSync
- fromStore
- getSubFrames
- init
- load
- onModelChange
- onSync
- onSyncFromMain
- saveToFile
- syncToWebViews
- toJSON
- unregisterIpcListener
- getInstance
- resetInstance
Constructors#
constructor#
+ Protectednew BaseStore(params: BaseStoreParams): BaseStore
Defined in src/common/base-store.ts:24
Parameters:
| Name | Type |
|---|---|
params |
BaseStoreParams |
Returns: BaseStore
Properties#
data#
• data: T = {} as T
Defined in src/common/base-store.ts:24
isLoaded#
• isLoaded: boolean = false
Defined in src/common/base-store.ts:23
params#
• Protected params: BaseStoreParams
Defined in src/common/base-store.ts:26
storeConfig#
• Protected storeConfig: Config\
Defined in src/common/base-store.ts:19
syncDisposers#
• Protected syncDisposers: Function[] = []
Defined in src/common/base-store.ts:20
whenLoaded#
• whenLoaded: Promise\
Defined in src/common/base-store.ts:22
Accessors#
name#
• get name(): string
Defined in src/common/base-store.ts:36
Returns: string
path#
• get path(): string
Defined in src/common/base-store.ts:40
Returns: string
syncChannel#
• get syncChannel(): string
Defined in src/common/base-store.ts:44
Returns: string
Methods#
applyWithoutSync#
▸ ProtectedapplyWithoutSync(callback: () => void): void
Defined in src/common/base-store.ts:120
Parameters:
| Name | Type |
|---|---|
callback |
() => void |
Returns: void
cwd#
▸ Protectedcwd(): string
Defined in src/common/base-store.ts:71
Returns: string
disableSync#
▸ disableSync(): void
Defined in src/common/base-store.ts:115
Returns: void
enableSync#
▸ enableSync(): void
Defined in src/common/base-store.ts:83
Returns: void
fromStore#
▸ ProtectedfromStore(data: T): void
Defined in src/common/base-store.ts:176
Parameters:
| Name | Type |
|---|---|
data |
T |
Returns: void
getSubFrames#
▸ ProtectedgetSubFrames(): Promise\
Defined in src/common/base-store.ts:164
Returns: Promise\
init#
▸ Protectedinit(): Promise\
Defined in src/common/base-store.ts:48
Returns: Promise\
load#
▸ load(): Promise\
Defined in src/common/base-store.ts:58
Returns: Promise\
onModelChange#
▸ ProtectedonModelChange(model: T): Promise\
Defined in src/common/base-store.ts:135
Parameters:
| Name | Type |
|---|---|
model |
T |
Returns: Promise\
onSync#
▸ ProtectedonSync(model: T): void
Defined in src/common/base-store.ts:128
Parameters:
| Name | Type |
|---|---|
model |
T |
Returns: void
onSyncFromMain#
▸ ProtectedonSyncFromMain(model: T): void
Defined in src/common/base-store.ts:105
Parameters:
| Name | Type |
|---|---|
model |
T |
Returns: void
saveToFile#
▸ ProtectedsaveToFile(model: T): Promise\
Defined in src/common/base-store.ts:75
Parameters:
| Name | Type |
|---|---|
model |
T |
Returns: Promise\
syncToWebViews#
▸ ProtectedsyncToWebViews(model: T): Promise\
Defined in src/common/base-store.ts:146
Parameters:
| Name | Type |
|---|---|
model |
T |
Returns: Promise\
toJSON#
▸ toJSON(): T
Defined in src/common/base-store.ts:182
Returns: T
unregisterIpcListener#
▸ unregisterIpcListener(): void
Defined in src/common/base-store.ts:111
Returns: void
getInstance#
▸ StaticgetInstance\args: ConstructorParameters\<Constructor\
Inherited from Singleton.getInstance
Defined in src/common/utils/singleton.ts:15
Type parameters:
| Name |
|---|
T |
Parameters:
| Name | Type |
|---|---|
...args |
ConstructorParameters\<Constructor\ |
Returns: T
resetInstance#
▸ StaticresetInstance(): void
Inherited from Singleton.resetInstance
Defined in src/common/utils/singleton.ts:22
Returns: void