load-yaml-file

Read and parse a YAML file.

Usage no npm install needed!

<script type="module">
  import loadYamlFile from 'https://cdn.skypack.dev/load-yaml-file';
</script>

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