metaconfiguration
TypeScript icon, indicating that this package has built-in type declarations

3.0.0 • Public • Published

Metarhia Configuration Loader

ci status snyk npm version npm downloads/month npm downloads license

Installation

  • npm install metaconfiguration --save
  • const { Config } = require('metaconfiguration');

Usage

Load configuration with asynchronous constructor:

const { Config } = require('metaconfiguration');
const config = await new Config('./configDirectory');
console.log(config);
// Output example:
// {
//   logger: {
//     enabled: true,
//     keepDays: 100,
//     writeInterval: 3000,
//     writeBuffer: 65536,
//     toStdout: [ 'system', 'fatal', 'error' ]
//   },
//   server: {
//     transport: 'http',
//     address: '127.0.0.1',
//     ports: 80
//   }
// }

or factory:

const { readConfig } = require('metaconfiguration');
const config = await readConfig('./configDirectory');

Specify certain configuration sections to load:

const { Config } = require('metaconfiguration');
const options = { names: ['application', 'gateway'] };
const config = await new Config('./configDirectory', options);

Loag configuration in specified mode:

const { Config } = require('metaconfiguration');
const options = { mode: 'test' };
const config = await new Config('./configDirectory', options);

Specify sections and mode:

const { Config } = require('metaconfiguration');
const options = { mode: 'test', names: ['application', 'gateway'] };
const config = await new Config('./configDirectory', options);

Use custom context (sandbox) to execute configuration js file in it:

const vm = require('node:vm');
const metautil = require('metautil');
const { Config } = require('metaconfiguration');
const context = { duration: metautil.duration };
vm.createContext(context);
const options = { context };
const config = await new Config('./configDirectory', options);

License & Contributors

Copyright (c) 2019-2023 Metarhia contributors. Metaconfiguration is MIT licensed.
Metaconfiguration is a part of Metarhia technology stack.

Package Sidebar

Install

npm i metaconfiguration

Weekly Downloads

72

Version

3.0.0

License

MIT

Unpacked Size

7.64 kB

Total Files

5

Last publish

Collaborators

  • timur.shemsedinov