yaml 2.0.0-0 → 2.0.0-1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # YAML <a href="https://www.npmjs.com/package/yaml"><img align="right" src="https://badge.fury.io/js/yaml.svg" title="npm package" /></a><a href="https://travis-ci.org/eemeli/yaml"><img align="right" src="https://travis-ci.org/eemeli/yaml.svg?branch=master" title="Build status" /></a>
1
+ # YAML <a href="https://www.npmjs.com/package/yaml"><img align="right" src="https://badge.fury.io/js/yaml.svg" title="npm package" /></a>
2
2
 
3
3
  `yaml` is a JavaScript parser and stringifier for [YAML](http://yaml.org/), 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.
4
4
 
@@ -28,21 +28,21 @@ const YAML = require('yaml')
28
28
 
29
29
  ### Parse & Stringify
30
30
 
31
- - [`YAML.parse(str, options): value`](https://eemeli.org/yaml/#yaml-parse)
32
- - [`YAML.stringify(value, options): string`](https://eemeli.org/yaml/#yaml-stringify)
31
+ - [`YAML.parse(str, reviver?, options?): value`](https://eemeli.org/yaml/#yaml-parse)
32
+ - [`YAML.stringify(value, replacer?, options?): string`](https://eemeli.org/yaml/#yaml-stringify)
33
33
 
34
34
  ### YAML Documents
35
35
 
36
36
  - [`YAML.defaultOptions`](https://eemeli.org/yaml/#options)
37
37
  - [`YAML.Document`](https://eemeli.org/yaml/#yaml-documents)
38
- - [`constructor(value, options)`](https://eemeli.org/yaml/#creating-documents)
38
+ - [`constructor(value, replacer?, options?)`](https://eemeli.org/yaml/#creating-documents)
39
39
  - [`defaults`](https://eemeli.org/yaml/#options)
40
- - [`#createNode(value, options): Node`](https://eemeli.org/yaml/#creating-nodes)
40
+ - [`#createNode(value, options?): Node`](https://eemeli.org/yaml/#creating-nodes)
41
41
  - [`#anchors`](https://eemeli.org/yaml/#working-with-anchors)
42
42
  - [`#contents`](https://eemeli.org/yaml/#content-nodes)
43
43
  - [`#errors`](https://eemeli.org/yaml/#errors)
44
- - [`YAML.parseAllDocuments(str, options): YAML.Document[]`](https://eemeli.org/yaml/#parsing-documents)
45
- - [`YAML.parseDocument(str, options): YAML.Document`](https://eemeli.org/yaml/#parsing-documents)
44
+ - [`YAML.parseAllDocuments(str, options?): YAML.Document[]`](https://eemeli.org/yaml/#parsing-documents)
45
+ - [`YAML.parseDocument(str, options?): YAML.Document`](https://eemeli.org/yaml/#parsing-documents)
46
46
 
47
47
  ```js
48
48
  import { Pair, YAMLMap, YAMLSeq } from 'yaml/types'
@@ -111,9 +111,8 @@ YAML.stringify([true, false, 'maybe', null])
111
111
  YAML.stringify({ number: 3, plain: 'string', block: 'two\nlines\n' })
112
112
  // `number: 3
113
113
  // plain: string
114
- // block: >
114
+ // block: |
115
115
  // two
116
- //
117
116
  // lines
118
117
  // `
119
118
  ```