mongo-helpers v0.0.7

mongo-helpers

The supporting API for mongodb data and collection operations, overwrite meteor/leaf4monkey:mongo-helpers

Installation

npm install mongo-helpers --save

Importing

import {MongoHelpers} from 'mongo-helpers';

or：

const MongoHelpers = require('mongo-helpers').MongoHelpers;

APIs

MongoHelpers.flatten (obj):

Flattening a document {a: {b: [{aa: 1, bb: 1}]}}，return {'a.b.0.aa': 1, 'a.b.0.bb': 1}

var o = {a: {b: [{aa: 1, bb: new Date()}]}};
o = JSON.stringify(MongoHelpers.flatten(o)); // '{"a.b.0.aa":1,"a.b.0.bb":"2016-07-06T03:42:53.511Z"}';

MongoHelpers.rebuild (flatten):

MongoHelpers.flatten (obj) reverse operation

MongoHelpers.flattenToModifier (base, mirror, options):

After flattening the incoming document, compare the key value pairs return modifier（include $set and $unset ）。

• arguments：

    `base {Object} `: 需要对比的对象
  
    `mirror {Object|null} `: 作为镜像来完成对比的对象
  
    `options.falsy {Array.<any>|undefined} `: 自定义的假值列表，如果 `base` 中的值在该列表中，则对应的属性将被纳入 unset 集，默认值为 `[null, undefined]`。
  
    `options.unsetNonProp {boolean} `: 是否将base中不包含的属性加入到 `unset` 集中，如果设置为 `true`，则需要先检查 `base` 中是否包含指定属性，再检查其值是否在假值列表中。
  
    `options.unsetAs {any} `: 统一设置 `unsetter` 中的键值，建议按照习惯设置为 `1` 或 `true`，如果传入的 `mirror` 参数为 `null`，则强制设置为 `true`，否则默认被设置为 `base` 对象中的值。

MongoHelpers.diffToFlatten (base, mirror, options):

将传入的文档扁平化后，对比键值对，获得两个对象的差异部分，仅在 mirror 中存在的值将在返回的结果中被设置为 undefined。参数列表与 MongoHelpers.flattenToModifier (base, mirror, options) 一致，但不可设置 options.unsetAs。