Interface IPersistor

a persistor is used to hook a data file into the store. This way any data file can be made available through the store and updated through actions, as long as it can be represented in json

Export

IPersistor

interface IPersistor {
    getAllKeys(): Bluebird<PersistorKey[]>;
    getAllKVs?(
        prefix?: string,
    ): Bluebird<{ key: PersistorKey; value: string }[]>;
    getItem(key: PersistorKey): Bluebird<string>;
    removeItem(key: PersistorKey): Bluebird<void>;
    setItem(key: PersistorKey, value: string): Bluebird<void>;
    setResetCallback(cb: () => Bluebird<void>): void;
}

Index

Methods

getAllKeys getAllKVs? getItem removeItem setItem setResetCallback

Methods

getAllKeys

getAllKeys(): Bluebird<PersistorKey[]>
Returns Bluebird<PersistorKey[]>
- Defined in node_modules/vortex-api/lib/types/IExtensionContext.d.ts:156

`Optional`getAllKVs

getAllKVs?(prefix?: string): Bluebird<{ key: PersistorKey; value: string }[]>
Parameters
- Optionalprefix: string
Returns Bluebird<{ key: PersistorKey; value: string }[]>
- Defined in node_modules/vortex-api/lib/types/IExtensionContext.d.ts:157

getItem

getItem(key: PersistorKey): Bluebird<string>
Parameters
- key: PersistorKey
Returns Bluebird<string>
- Defined in node_modules/vortex-api/lib/types/IExtensionContext.d.ts:153

removeItem

removeItem(key: PersistorKey): Bluebird<void>
Parameters
- key: PersistorKey
Returns Bluebird<void>
- Defined in node_modules/vortex-api/lib/types/IExtensionContext.d.ts:155

setItem

setItem(key: PersistorKey, value: string): Bluebird<void>
Parameters
- key: PersistorKey
- value: string
Returns Bluebird<void>
- Defined in node_modules/vortex-api/lib/types/IExtensionContext.d.ts:154

setResetCallback

setResetCallback(cb: () => Bluebird<void>): void
Parameters
- cb: () => Bluebird<void>
Returns void
- Defined in node_modules/vortex-api/lib/types/IExtensionContext.d.ts:152