From 4480ca3558be7758850486e14d6286bb59fdba3a Mon Sep 17 00:00:00 2001 From: lwalkin Date: Fri, 10 Oct 2014 23:18:06 +0000 Subject: [PATCH] documentation for with_trailer option --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index a609b77..174f660 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,10 @@ The options for decode are: * `return_maps` - Tell Jiffy to return objects using the maps data type on VMs that support it. This raises an error on VMs that don't support maps. +* `with_trailer` - Tell Jiffy to return the trailing unparsed data (if any) along with + the parsed term instead of failing with {error,{_,invalid_traling_data}}. When + the trailer is available, the return value is {with_trailer, EJson, Trailer}, + where Trailer is a sub-binary of the input, for efficiency. `jiffy:encode/1,2` ------------------