/*!
* Copyright 2017 - 2020 by ChartIQ, Inc.
* All rights reserved.
*/
/**
* The Storage Client handles saving and retrieving data for your smart desktop.
*
*
* See the Storing Data tutorial for an overview of using the Storage Client.
* @module StorageClient
*/
import { ComponentMutateParams } from "../services/window/WindowAbstractions/BaseWindow";
import { StandardErrorCallback, StandardPromise } from "../types";
/**
* Define the user name for storage (i.e., each user has unique storage).
*
* ```javascript
* FSBL.Clients.StorageClient.setUser({ user: "JohnDeere"});
* ```
* @param params
* @param params.user A unique key to store user data under
* @param cb Callback to be called on success.
*/
export declare const setUser: (params: {
user: string;
}, cb?: StandardErrorCallback) => StandardPromise;
/**
* @deprecated This method has been deprecated.
*
* Specifies the data store. For normal operation this function doesn't have to be invoked -- the default data store is set in configuration.
*
* ```javascript
* FSBL.Clients.StorageClient.setStore({topic:"finsemble", dataStore:"redis"})
* ```
* @param params
* @param params.topic If specified then data store is set only for topic.
* @param params.dataStore Identifies the data store (e.g. "localStorage", "redis").
* @param cb Callback to be called on success.
* @ignore
*/
export declare const setStore: (params: {
topic: string;
dataStore?: string;
}, cb?: StandardErrorCallback) => StandardPromise;
/**
* Save a key value pair into storage.
*
* ```javascript
* FSBL.Clients.StorageClient.save({topic:"finsemble", key:"testKey", value:"testValue"});
* FSBL.Clients.StorageClient.save({topic:"finsemble", key:"testKey", value:"testValue"}, (err, data) => {});
* const {err, data} = await FSBL.Clients.StorageClient.save({topic:"finsemble", key:"testKey", value:"testValue"});
* ```
* @param params
* @param params.topic Storage topic for key being stored.
* @param params.key The key for the value to be stored under.
* @param params.value The value to be stored.
* @param cb Callback to be called on success.
*/
export declare const save: (params: ComponentMutateParams, cb?: StandardErrorCallback) => StandardPromise;
/**
* Get a value from storage.
*
*
* ```javascript
* FSBL.Clients.StorageClient.getStandardized({ topic:"finsemble", key:"testKey" }, function(err, data) {
* let myData = data;
* });
* const {err, data} = await FSBL.Clients.StorageClient.getStandardized({ topic:"finsemble", key:"testKey" });
* ```
* @param params
* @param params.key The key to get from storage.
* @param params.topic The topic that the data is saved under.
* @param cb Callback to be called on success.
*/
export declare const getStandardized: (params: {
key: string;
topic: string;
}, cb?: StandardErrorCallback | undefined) => StandardPromise;
/**
* @deprecated
* Please use getStandardized() for a standardized `Promise<{err, data}>`
* This function returns a `Promise` and rejects on an error. This is maintained for backward compatibility.
*
* Get a value from storage.
*
* ```javascript
* FSBL.Clients.StorageClient.get({ topic:"finsemble", key:"testKey" }, function(err, data) {
* var myData = data;
* });
* ```
*
* @param params
* @param params.key The key to get from storage.
* @param params.topic The topic that the data is saved under.
* @param cb Callback to be called on success.
*/
export declare const get: (params: {
key: string;
topic: string;
}, cb?: StandardErrorCallback | undefined) => Promise;
/**
* Get all keys for the topic.
*
* ```javascript
* FSBL.Clients.StorageClient.keys({topic:"finsemble", keyPrefix:"test"}, function(err, data){
* let myKeys = data;
* });
* const {err, data} = await FSBL.Clients.StorageClient.keys({topic:"finsemble", keyPrefix:"test"});
* ```
* @param params
* @param params.topic Topic for the keys to return.
* @param params.keyPrefix Filter all keys that don't start with this prefix.
* @param cb Callback to be called on success.
*/
export declare const keys: (params: {
topic: string;
keyPrefix?: string;
}, cb?: StandardErrorCallback) => StandardPromise;
/**
* Get a multiple values from storage based on regex.(coming soon)
* @param params
* @param cb Callback to be called on success.
* @ignore
* @deprecated
*/
export declare const getMultiple: (params: any, cb?: StandardErrorCallback) => StandardPromise;
/**
* Delete a value from storage.
*
* ```javascript
* FSBL.Clients.StorageClient.remove({ key:"testKey" })
* await FSBL.Clients.StorageClient.remove({ key:"testKey" })
* ```
* @param params
* @param params.key The key to get from storage.
* @param params.topic The topic that the data is saved under.
* @param cb Callback to be called on success.
*/
export declare const remove: (params: {
key: string;
topic: string;
}, cb?: StandardErrorCallback) => StandardPromise;
/**
* @deprecated
*/
export declare const deleteInner: (...args: any[]) => void;
/**
* Clears a storage adapter of all data.
* @param cb The callback to be invoked after the method completes successfully.
*/
export declare const clearCache: (cb?: StandardErrorCallback) => StandardPromise;
/**
* @ignore
*/
export declare const StorageClient: {
/**
* For backward compatibility
* @private
* @deprecated
*/
initialize: () => void;
/**
* For backward compatibility
* @private
* @deprecated
*/
onReady: (cb?: any) => void;
clearCache: (cb?: StandardErrorCallback) => StandardPromise;
remove: (params: {
key: string;
topic: string;
}, cb?: StandardErrorCallback) => StandardPromise;
getMultiple: (params: any, cb?: StandardErrorCallback) => StandardPromise;
keys: (params: {
topic: string;
keyPrefix?: string;
}, cb?: StandardErrorCallback) => StandardPromise;
getStandardized: (params: {
key: string;
topic: string;
}, cb?: StandardErrorCallback | undefined) => StandardPromise;
get: (params: {
key: string;
topic: string;
}, cb?: StandardErrorCallback | undefined) => Promise;
save: (params: ComponentMutateParams, cb?: StandardErrorCallback) => StandardPromise;
setStore: (params: {
topic: string;
dataStore?: string;
}, cb?: StandardErrorCallback) => StandardPromise;
setUser: (params: {
user: string;
}, cb?: StandardErrorCallback) => StandardPromise;
delete: (...args: any[]) => void;
remove1: (params: {
key: string;
topic: string;
}) => void;
get1: (params: {
key: string;
topic: string;
}, cb?: StandardErrorCallback | undefined) => Promise;
save1: (params: {
key: string;
topic: string;
value: any;
}) => void;
keys1: (params: {
topic: string;
keyPrefix?: string;
}) => Promise;
};
/**
* @ignore
*/
export default StorageClient;
//# sourceMappingURL=storageClient.d.ts.map