balena-settings-storage/build/storage.d.ts

Balena settings storage utilities

import { BalenaSettingsStorage, StorageLike } from './types';
/**
 * @module storage
 */
/**
 * @summary Get an instance of storage module
 * @function
 * @static
 * @public
 *
 * @param {Object} options - options
 * @param {String|False} [options.dataDirectory] - the directory to use for storage in Node.js or false to create an isolated in memory instance. Values other than false are ignored in the browser.
 *
 * @return {storage}
 * @example
 * // with es6 imports
 * import { getStorage } from 'balena-settings-storage';
 * // or with node require
 * const { getStorage } = require('balena-settings-storage');
 *
 * const storage = getStorage({
 * 	dataDirectory: '/opt/cache/balena'
 * });
 */
export declare const getStorage: (store: StorageLike) => BalenaSettingsStorage;