read-yaml-file

What is read-yaml-file?

The read-yaml-file npm package is a simple utility for reading YAML files and converting them into JavaScript objects. It is useful for configuration files, data storage, and other scenarios where YAML is preferred over JSON or other formats.

What are read-yaml-file's main functionalities?

Read YAML File

This feature allows you to read a YAML file and convert its contents into a JavaScript object. The function returns a promise that resolves with the parsed data or rejects with an error.

const readYamlFile = require('read-yaml-file');

readYamlFile('path/to/file.yaml').then(data => {
  console.log(data);
}).catch(error => {
  console.error(error);
});

Synchronous Read

This feature provides a synchronous method to read a YAML file. It immediately returns the parsed data or throws an error if the file cannot be read.

const readYamlFile = require('read-yaml-file');

try {
  const data = readYamlFile.sync('path/to/file.yaml');
  console.log(data);
} catch (error) {
  console.error(error);
}

Other packages similar to read-yaml-file

js-yaml

js-yaml is a comprehensive YAML parser and dumper for JavaScript. It offers more advanced features compared to read-yaml-file, such as schema support, custom types, and the ability to dump JavaScript objects back into YAML format.

yaml

yaml is another powerful YAML parser and stringifier for JavaScript. It provides a more extensive API for working with YAML data, including support for parsing and stringifying YAML, handling custom tags, and more.

yamljs

yamljs is a lightweight YAML parser and stringifier. It offers basic functionality similar to read-yaml-file but also includes the ability to convert JavaScript objects to YAML strings.

README

read-yaml-file

Read and parse a YAML file

Installation

<npm|yarn|pnpm> add read-yaml-file

Usage

const readYamlFile = require('read-yaml-file')

readYamlFile('foo.yml').then(data => {
  console.log(data)
  //=> {foo: true}
})

API

readYamlFile(filepath)

Returns a promise for the parsed YAML.

readYamlFile.sync(filepath)

Returns the parsed YAML.

Related

• write-yaml-file - Stringify and write YAML to a file atomically

License

MIT © Zoltan Kochan

---

This package was forked from load-yaml-file