PrefsStore
Extends
Constructors
Constructor
new PrefsStore(): PrefsStore;
Returns
PrefsStore
Overrides
AbstractPersistedStore.constructor
Properties
| Property | Type | Inherited from |
|---|---|---|
categories | { [key: string]: PrefsCategory; } | - |
logger | Logger | AbstractPersistedStore.logger |
Accessors
initialized
Inherited from
AbstractPersistedStore.initialized
name
Get Signature
get name(): string;
Returns
string
Inherited from
Methods
deserialize()
deserialize(data): Promise<void>;
Parameters
| Parameter | Type |
|---|---|
data | PrefsSerialized |
Returns
Promise<void>
Overrides
AbstractPersistedStore.deserialize
getControls()
getControls(): AbstractSetting<AbstractSettingOptions>[];
Returns
AbstractSetting<AbstractSettingOptions>[]
Inherited from
AbstractPersistedStore.getControls
getInteractiveControls()
getInteractiveControls(): AbstractInteractiveSetting<AbstractInteractiveControlOptions>[];
Returns
AbstractInteractiveSetting<AbstractInteractiveControlOptions>[]
getPreference()
getPreference<T>(key): T;
Type Parameters
| Type Parameter |
|---|
T extends AbstractSetting<AbstractSettingOptions> |
Parameters
| Parameter | Type |
|---|---|
key | string |
Returns
T
init()
init(): Promise<void>;
Returns
Promise<void>
Inherited from
registerPreference()
registerPreference(pref): void;
Parameters
| Parameter | Type |
|---|---|
pref | AbstractSetting |
Returns
void
registerPreferenceCategory()
registerPreferenceCategory(category): void;
Parameters
| Parameter | Type |
|---|---|
category | PrefsCategory |
Returns
void
reset()
reset(): Promise<void>;
Returns
Promise<void>
runDeserialization()
runDeserialization(): Promise<boolean>;
Returns
Promise<boolean>
Inherited from
AbstractPersistedStore.runDeserialization
save()
save(): Promise<void>;
Returns
Promise<void>
Inherited from
serialize()
serialize(): PrefsSerialized;
Returns
Overrides
AbstractPersistedStore.serialize
setLogger()
setLogger(logger): void;
Parameters
| Parameter | Type |
|---|---|
logger | Logger |
Returns
void
Inherited from
AbstractPersistedStore.setLogger
updateOptions()
updateOptions(options): void;
Parameters
| Parameter | Type |
|---|---|
options | Partial<Omit<AbstractPersistedStoreOptions<T>, "name">> |
Returns
void
Inherited from
AbstractPersistedStore.updateOptions
waitForReady()
waitForReady(): Promise<void>;
Returns
Promise<void>