@nlabs/arkhamjs-storage-node
Version:
NodeJS storage for ArkhamJS
59 lines • 1.99 kB
TypeScript
/**
* Copyright (c) 2018-Present, Nitrogen Labs, Inc.
* Copyrights licensed under the MIT License. See the accompanying LICENSE file for terms.
*/
import { InitOptions } from 'node-persist';
export declare class NodeStorage {
private options;
constructor(options?: InitOptions);
/**
* Removes all keys from persistent data.
*
* @returns {Promise<boolean>} Whether data was successfully removed.
*/
static clearPersistData(): Promise<boolean>;
/**
* Removes a key from persistent data.
*
* @param {string} key Key associated with the data to remove.
* @returns {Promise<boolean>} Whether data was successfully removed.
*/
static delPersistData(key: string): Promise<boolean>;
/**
* Get a key value from persistent data.
*
* @param {string} key The key for data.
* @returns {Promise<any>} the data object associated with the key.
*/
static getPersistData(key: string): Promise<any>;
/**
* Saves data to persistent data.
*
* @param {string} key Key to store data.
* @param {any} value Data to store.
* @returns {Promise<boolean>} Whether data was successfully saved.
*/
static setPersistData(key: string, value: any): Promise<boolean>;
/**
* Clears all data from storage.
*
* @returns {Promise<boolean>} Whether data was successfully saved.
*/
clearStorageData(): Promise<boolean>;
/**
* Get a key value from storage.
*
* @param {string} key The key for data.
* @returns {Promise<any>} the data object associated with the key.
*/
getStorageData(key: string): Promise<any>;
/**
* Saves data to storage.
*
* @param {string} key Key to store data.
* @param {any} value Data to store.
* @returns {Promise<boolean>} Whether data was successfully saved.
*/
setStorageData(key: string, value: any): Promise<boolean>;
}
//# sourceMappingURL=NodeStorage.d.ts.map