Skip to content

Commit

Permalink
Merge pull request nodeca#508 from fabiospampinato/master
Browse files Browse the repository at this point in the history 
Readme: clarified “safeLoad” return type
  • Loading branch information
Vitaly Puzrin authored Jul 10, 2019
2 parents 665aadd + 7d507cb commit 1d4c8c6
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -95,9 +95,9 @@ try {

### safeLoad (string [ , options ])

**Recommended loading way.** Parses `string` as single YAML document. Returns a JavaScript
object or throws `YAMLException` on error. By default, does not support regexps,
functions and undefined. This method is safe for untrusted data.
**Recommended loading way.** Parses `string` as single YAML document. Returns either a
plain object, a string or `undefined`, or throws `YAMLException` on error. By default, does
not support regexps, functions and undefined. This method is safe for untrusted data.

options:

Expand Down

0 comments on commit 1d4c8c6

Please sign in to comment.