document return_tail

This commit is contained in:
alisdair sullivan 2015-08-04 10:58:44 -07:00
parent 1bacdd44bd
commit e382aca486

View file

@ -347,6 +347,7 @@ option() = dirty_strings
| stream | stream
| strict | strict
| {strict, [strict_option()]} | {strict, [strict_option()]}
| return_tail
| uescape | uescape
| unescaped_jsonp | unescaped_jsonp
@ -421,6 +422,13 @@ additional options beyond these. see
any combination of these can be passed to **jsx** by using `{strict, [strict_option()]}`. any combination of these can be passed to **jsx** by using `{strict, [strict_option()]}`.
`strict` is equivalent to `{strict, [comments, bad_utf8, single_quotes, escapes]}` `strict` is equivalent to `{strict, [comments, bad_utf8, single_quotes, escapes]}`
- `return_tail`
upon reaching the end of a valid json term in an input stream return the term and any
remaining bytes in the input stream as `{with_tail, term(), binary()}` where the second
member of the tuple is the json term and the third is any remaining bytes. note that
leading whitespace will be stripped from the tail
- `uescape` - `uescape`
escape all codepoints outside the ascii range for 7 bit clean output. note escape all codepoints outside the ascii range for 7 bit clean output. note