couchdb-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From kxe...@apache.org
Subject [38/54] jiffy commit: updated refs/heads/master to ef77de4
Date Tue, 28 Jul 2015 22:43:03 GMT
Document new encoding and decoding options


Project: http://git-wip-us.apache.org/repos/asf/couchdb-jiffy/repo
Commit: http://git-wip-us.apache.org/repos/asf/couchdb-jiffy/commit/3458b79c
Tree: http://git-wip-us.apache.org/repos/asf/couchdb-jiffy/tree/3458b79c
Diff: http://git-wip-us.apache.org/repos/asf/couchdb-jiffy/diff/3458b79c

Branch: refs/heads/master
Commit: 3458b79cac9fa612cd004bbcc4e46ca67463c08b
Parents: 5d6b265
Author: Paul J. Davis <paul.joseph.davis@gmail.com>
Authored: Wed Jul 15 15:35:51 2015 -0500
Committer: Paul J. Davis <paul.joseph.davis@gmail.com>
Committed: Wed Jul 15 15:35:51 2015 -0500

----------------------------------------------------------------------
 README.md | 7 +++++++
 1 file changed, 7 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/couchdb-jiffy/blob/3458b79c/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 1e95bc0..7f51ce1 100644
--- a/README.md
+++ b/README.md
@@ -42,6 +42,11 @@ 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.
+* `{null_term, Term}` - Returns the specified `Term` instead of `null`
+  when decoding JSON. This is for people that wish to use `undefined`
+  instead of `null`.
+* `use_nil` - Returns the atom `nil` instead of `null` when decoding
+  JSON. This is a short hand for `{null_term, nil}`.
 
 `jiffy:encode/1,2`
 ------------------
@@ -62,6 +67,8 @@ The options for encode are:
 * `{bytes_per_iter, N}` where N &gt;= 0 - This controls the number of
   bytes that Jiffy will generate before yielding back to the VM. The
   mechanics of this yield are completely hidden from the end user.
+* `escape_forward_slashes` - Escapes the `/` character which can be
+  useful when encoding URLs in some cases.
 
 Data Format
 -----------


Mime
View raw message