yaml

by eemeli

eemeli / yaml

JavaScript parser and stringifier for YAML

281 Stars 30 Forks Last release: 22 days ago (v2.0.0-1) ISC License 904 Commits 42 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

YAML

yaml
is a JavaScript parser and stringifier for YAML, a human friendly data serialization standard. It supports both parsing and stringifying data using all versions of YAML, along with all common data schemas. As a particularly distinguishing feature,
yaml
fully supports reading and writing comments and blank lines in YAML documents.

The library is released under the ISC open source license, and the code is available on GitHub. It has no external dependencies and runs on Node.js 6 and later, and in browsers from IE 11 upwards.

For the purposes of versioning, any changes that break any of the endpoints or APIs documented here will be considered semver-major breaking changes. Undocumented library internals may change between minor versions, and previous APIs may be deprecated (but not removed).

For more information, see the project's documentation site: eemeli.org/yaml

To install:

npm install [email protected]

Note: These docs are for

[email protected]
. For v1, see the v1.10.0 tag for the source and eemeli.org/yaml/v1 for the documentation.

API Overview

The API provided by

yaml
has three layers, depending on how deep you need to go: Parse & Stringify, Documents, and the CST Parser. The first has the simplest API and "just works", the second gets you all the bells and whistles supported by the library along with a decent AST, and the third is the closest to YAML source, making it fast, raw, and crude.
import YAML from 'yaml'
// or
const YAML = require('yaml')

Parse & Stringify

YAML Documents

import { Pair, YAMLMap, YAMLSeq } from 'yaml/types'

CST Parser

import parseCST from 'yaml/parse-cst'

YAML.parse

# file.yml
YAML:
  - A human-readable data serialization language
  - https://en.wikipedia.org/wiki/YAML
yaml:
  - A complete JavaScript implementation
  - https://www.npmjs.com/package/yaml
import fs from 'fs'
import YAML from 'yaml'

YAML.parse('3.14159') // 3.14159

YAML.parse('[ true, false, maybe, null ]\n') // [ true, false, 'maybe', null ]

const file = fs.readFileSync('./file.yml', 'utf8') YAML.parse(file) // { YAML: // [ 'A human-readable data serialization language', // 'https://en.wikipedia.org/wiki/YAML' ], // yaml: // [ 'A complete JavaScript implementation', // 'https://www.npmjs.com/package/yaml' ] }

YAML.stringify

import YAML from 'yaml'

YAML.stringify(3.14159) // '3.14159\n'

YAML.stringify([true, false, 'maybe', null]) // - true // - false // - maybe // - null //

YAML.stringify({ number: 3, plain: 'string', block: 'two\nlines\n' }) // number: 3 // plain: string // block: | // two // lines //


Browser testing provided by:

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.