config-storage
Installation
npm i config-storage
Usage
🔵 Importing
// using require
const { ConfigurationStorage } = require('config-storage');
// using import
import { ConfigurationStorage } from 'config-storage';
🔵 Initialization
ConfigurationStorage.getStorage(storageName: string)
const config = await ConfigurationStorage.getStorage('my_application');
Passing storageName
allows you to identify your storage with a key. This also means that you can have as many storages as you want.
const mainConfig = await ConfigurationStorage.getStorage('main_configuration');
const userConfig = await ConfigurationStorage.getStorage('user_configuration');
const paymentConfig = await ConfigurationStorage.getStorage('payment_configuration');
For all of the following methods that expect a key, you can use dot-notation to refer to nested values. For instance, the key DATABASES.mysql.hostname
refers to an object like:
{
DATABASES: {
mysql: {
hostname: 'localhost'
}
}
}
🔵 Storing values
set(key: string, value: any): Promise<void>
await config.set('MAIN_KEY', 'GiQTZ8yKBcfuEnTFbs3TvcqoAsF6owLu');
🔵 Retrieving values
get(key: string, defaultValue: any = null): Promise<any>
It returns defaultValue
if the key doesn't exist.
await config.get('MAIN_KEY');
getAll(): Promise<Configuration>
await config.getAll();
🔵 Removing values
del(key: string): Promise<void>
await config.del('MAIN_KEY');
🔵 Checking existence
exists(key: string): Promise<boolean>
await config.exists('MAIN_KEY');
🔵 Cleaning all the stored configuration
clean(): Promise<void>
await config.clean();