From e382aca486f00e62c1f5a63d00b2ab7e1f52e4e6 Mon Sep 17 00:00:00 2001 From: alisdair sullivan Date: Tue, 4 Aug 2015 10:58:44 -0700 Subject: [PATCH] document `return_tail` --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 21386a0..1cb36ed 100644 --- a/README.md +++ b/README.md @@ -347,6 +347,7 @@ option() = dirty_strings | stream | strict | {strict, [strict_option()]} + | return_tail | uescape | 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()]}`. `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` escape all codepoints outside the ascii range for 7 bit clean output. note