@dynaconfig/yaml
TypeScript icon, indicating that this package has built-in type declarations

2.0.0 • Public • Published

@dynaconfig/yaml

npm license

A configuration generation library using *.yaml files.

Usage

'./config.yaml', before script:

PASSWORD: "password"
HASHED: "false"

'./index.js', run script:

// ...
const { async: AsyncYamlStore } = require("@dynaconfig/yaml");

// Creates a new instance. 'yamlPath' is the file path
const store = new AsyncYamlStore(yamlPath);

// Every time a new session is created, the store
// loads the configurations from the file
store.newSession().then(async (session) => {
  // Gets the configuration object
  const config = session.getConfig();

  const password = config["PASSWORD"]; // "password"
  config["PASSWORD_HASH"] = md5hash(password);
  config["HASHED"] = "true";
  delete config["PASSWORD"];

  // Writes the new configuration object to the file
  await store.persistSession(session);

  // Reloads the configurations from the file
  await session.refreshConfig();

  // ...

  return;
});

'./config.yaml', after script:

HASHED: "true"
PASSWORD_HASH: 5f4dcc3b5aa765d61d8327deb882cf99

For more examples, check out @dynaconfig/core.

License

MIT

Readme

Keywords

none

Package Sidebar

Install

npm i @dynaconfig/yaml

Weekly Downloads

1

Version

2.0.0

License

MIT

Unpacked Size

26.7 kB

Total Files

23

Last publish

Collaborators

  • icarus21