load-yaml-file

What is load-yaml-file?

The 'load-yaml-file' npm package is a simple utility for reading and parsing YAML files in Node.js. It provides a straightforward way to load YAML content into JavaScript objects, making it easy to work with configuration files and other data stored in YAML format.

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

Load YAML File

This feature allows you to load and parse a YAML file asynchronously. The 'loadYamlFile' function reads the specified YAML file and returns a promise that resolves with the parsed data.

const loadYamlFile = require('load-yaml-file');

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

Other packages similar to load-yaml-file

js-yaml

The 'js-yaml' package is a popular YAML parser and dumper for JavaScript. It provides more extensive functionality compared to 'load-yaml-file', including the ability to parse YAML strings, dump JavaScript objects to YAML, and customize the parsing and dumping process. It is more versatile and widely used in the community.

yaml

The 'yaml' package is another comprehensive YAML parser and stringifier for JavaScript. It offers a rich set of features, including support for YAML 1.2, custom schema definitions, and detailed error reporting. It is more feature-rich compared to 'load-yaml-file' and is suitable for more complex YAML processing tasks.

yamljs

The 'yamljs' package is a lightweight YAML parser and stringifier for JavaScript. It provides basic functionality for loading and dumping YAML content, similar to 'load-yaml-file'. However, it also includes a command-line interface for converting between YAML and JSON, making it a versatile tool for simple YAML processing tasks.

README

Load YAML file

Read and parse a YAML file.

Installation

npm install --save load-yaml-file

Usage

import { loadYamlFile } from 'load-yaml-file'

const data = await loadYamlFile('foo.yml')
console.log(data)
//=> {foo: true}

Sync

import { loadYamlFileSync } from 'load-yaml-file'

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

API

loadYamlFile(path)

• path (string | Buffer | URL, required)
• returns Promise<unknown> - a promise for the parsed YAML

loadYamlFileSync(path)

• path (string | Buffer | URL, required)
• returns unknown - the parsed YAML

Related

• write-yaml-file - Stringify and write YAML to a file atomically
• load-json-file - Read and parse a JSON file