write-yaml-file

What is write-yaml-file?

The write-yaml-file npm package allows you to write YAML files easily from JavaScript objects. It is useful for configuration management, data serialization, and other tasks where YAML is preferred over JSON or other formats.

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

Write a simple YAML file

This feature allows you to write a simple YAML file from a JavaScript object. The code sample demonstrates how to create a YAML file named 'output.yaml' with basic user information.

const writeYamlFile = require('write-yaml-file');

const data = {
  name: 'John Doe',
  age: 30,
  occupation: 'Software Developer'
};

writeYamlFile('output.yaml', data).then(() => {
  console.log('YAML file written successfully!');
});

Write a nested YAML file

This feature allows you to write a nested YAML file from a JavaScript object. The code sample demonstrates how to create a YAML file named 'nested_output.yaml' with nested user information.

const writeYamlFile = require('write-yaml-file');

const data = {
  user: {
    name: 'Jane Doe',
    details: {
      age: 28,
      occupation: 'Data Scientist'
    }
  }
};

writeYamlFile('nested_output.yaml', data).then(() => {
  console.log('Nested YAML file written successfully!');
});

Write a YAML file with custom options

This feature allows you to write a YAML file with custom options such as indentation. The code sample demonstrates how to create a YAML file named 'custom_output.yaml' with a custom indentation of 4 spaces.

const writeYamlFile = require('write-yaml-file');

const data = {
  name: 'Alice',
  age: 25,
  occupation: 'Graphic Designer'
};

const options = {
  indent: 4
};

writeYamlFile('custom_output.yaml', data, options).then(() => {
  console.log('YAML file with custom options written successfully!');
});

Other packages similar to write-yaml-file

js-yaml

js-yaml is a popular YAML parser and dumper for JavaScript. It provides more comprehensive functionality for both reading and writing YAML files compared to write-yaml-file. However, it requires more setup and configuration for writing files.

yaml

yaml is another robust YAML parser and stringifier for JavaScript. It offers a wide range of features for working with YAML data, including schema support and custom types. It is more feature-rich but also more complex to use than write-yaml-file.

yamljs

yamljs is a lightweight YAML parser and writer for JavaScript. It is similar to write-yaml-file in terms of simplicity and ease of use but offers additional features like converting YAML to JSON and vice versa.

README

write-yaml-file

Stringify and write YAML to a file atomically

Creates directories for you as needed.

Installation

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

Usage

const writeYamlFile = require('write-yaml-file')

writeYamlFile('foo.yaml', {foo: true}).then(() => {
  console.log('done')
})

API

writeYamlFile(filepath, data, [options])

Returns a promise.

writeYamlFile.sync(filepath, data, [options])

options

Same options that can be passed in to js-yaml

mode

Type: number Default 438 (0666 in octal)

Mode used when writing the file.

makeDir

Type: boolean Default: true

Creates the directory to which the YAML file is written.

Related

• load-yaml-file - Read and parse a YAML file

License

MIT © Zoltan Kochan