Skip to content

Add option to exclude function properties when encoding objects #78

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
brentd wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add option to exclude function properties when encoding objects #78

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions lib/write-type.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ exports.getWriteType = getWriteType;
function getWriteType(options) {
var token = WriteToken.getWriteToken(options);
var useraw = options && options.useraw;
var functions = options && options.functions;
var binarraybuffer = HAS_UINT8ARRAY && options && options.binarraybuffer;
var isBuffer = binarraybuffer ? Bufferish.isArrayBuffer : Bufferish.isBuffer;
var bin = binarraybuffer ? bin_arraybuffer : bin_buffer;
Expand Down Expand Up @@ -229,6 +230,10 @@ function getWriteType(options) {
// map 32 -- 0xdf
function obj_to_map(encoder, value) {
var keys = Object.keys(value);

if (!functions)
keys = keys.filter(function(key) { return !(value[key] instanceof Function); });

var length = keys.length;
var type = (length < 16) ? (0x80 + length) : (length <= 0xFFFF) ? 0xde : 0xdf;
token[type](encoder, length);
Expand Down
26 changes: 26 additions & 0 deletions test/28.functions.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
#!/usr/bin/env mocha -R spec

var assert = require("assert");
var msgpackJS = "../index";
var isBrowser = ("undefined" !== typeof window);
var msgpack = isBrowser && window.msgpack || require(msgpackJS);
var TITLE = __filename.replace(/^.*\//, "");
var obj = {func: function() {}};

describe(TITLE, function() {
it("functions: false", function() {
var options = {codec: msgpack.createCodec({functions: false})};

// as default
assert.deepEqual(msgpack.decode(msgpack.encode(obj)), {});

// explicit
assert.deepEqual(msgpack.decode(msgpack.encode(obj, options)), {});
});

it("functions: true", function() {
var options = {codec: msgpack.createCodec({functions: true})};

assert.deepEqual(msgpack.decode(msgpack.encode(obj, options)), {"func": null});
});
});