@coffeekraken/s-config-adapter

@coffeekraken/s-config-adapter

MIT 2.0.0-alpha.20 - Git repository

Base class to use to create config adapters like the @coffeekraken/s-config-folder-adapter.

Install

npm i @coffeekraken/s-config-adapter

SConfigAdapter

This package expose a simple SConfigAdapter class that has to be used as base when creating an SConfig adapter.

Features

• Provide an update method to call when some configs has been changed.
  • For example, the SConfigFolderAdapter call this method when a configuration file has been updated
• And more...

Usage

Here's a simple example how to use the SConfigAdapter class:

import __SConfigAdapter from '@coffeekraken/s-config-adapter';
import type { ISConfigAdapterLoadParams } from '@coffeekraken/s-config-adapter';

class MyConfigAdapter extends __SConfigAdapter {
  constructor() {
    super({
      some: 'settings',
    });
    // listen for configuration change...
    myCoolLiteneingFunction(() => {
      // call the "update" method on the adapter
      this.update();
    });
  }
  async load(params: ISConfigAdapterLoadParams): Promise<any> {
    // load your configuration like you want....
    // return a simple configuration object
    return {
      my: 'config',
    };
  }
}
const myConfig = new __SConfig('my-config', new MyConfigAdapter());
myConfig.get('my'); // config

API

For more information about the API, please check out the API documentation

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Here's all the ways you can contact us listed: