{
  "name": "mpath",
  "version": "0.1.1",
  "description": "{G,S}et object values using MongoDB path notation",
  "main": "index.js",
  "scripts": {
    "test": "make test"
  },
  "repository": {
    "type": "git",
    "url": "git://github.com/aheckmann/mpath.git"
  },
  "keywords": [
    "mongodb",
    "path",
    "get",
    "set"
  ],
  "author": {
    "name": "Aaron Heckmann",
    "email": "aaron.heckmann+github@gmail.com"
  },
  "license": "MIT",
  "devDependencies": {
    "mocha": "1.6.0"
  },
  "readme": "#mpath\n\n{G,S}et javascript object values using MongoDB-like path notation.\n\n###Getting\n\n```js\nvar mpath = require('mpath');\n\nvar obj = {\n    comments: [\n      { title: 'funny' },\n      { title: 'exciting!' }\n    ]\n}\n\nmpath.get('comments.1.title', obj) // 'exciting!'\n```\n\n`mpath.get` supports array property notation as well.\n\n```js\nvar obj = {\n    comments: [\n      { title: 'funny' },\n      { title: 'exciting!' }\n    ]\n}\n\nmpath.get('comments.title', obj) // ['funny', 'exciting!']\n```\n\nArray property and indexing syntax, when used together, are very powerful.\n\n```js\nvar obj = {\n  array: [\n      { o: { array: [{x: {b: [4,6,8]}}, { y: 10} ] }}\n    , { o: { array: [{x: {b: [1,2,3]}}, { x: {z: 10 }}, { x: 'Turkey Day' }] }}\n    , { o: { array: [{x: {b: null }}, { x: { b: [null, 1]}}] }}\n    , { o: { array: [{x: null }] }}\n    , { o: { array: [{y: 3 }] }}\n    , { o: { array: [3, 0, null] }}\n    , { o: { name: 'ha' }}\n  ];\n}\n\nvar found = mpath.get('array.o.array.x.b.1', obj);\n\nconsole.log(found); // prints..\n\n    [ [6, undefined]\n    , [2, undefined, undefined]\n    , [null, 1]\n    , [null]\n    , [undefined]\n    , [undefined, undefined, undefined]\n    , undefined\n    ]\n\n```\n\n#####Field selection rules:\n\nThe following rules are iteratively applied to each `segment` in the passed `path`. For example:\n\n```js\nvar path = 'one.two.14'; // path\n'one' // segment 0\n'two' // segment 1\n14    // segment 2\n```\n\n- 1) when value of the segment parent is not an array, return the value of `parent.segment`\n- 2) when value of the segment parent is an array\n  - a) if the segment is an integer, replace the parent array with the value at `parent[segment]`\n  - b) if not an integer, keep the array but replace each array `item` with the value returned from calling `get(remainingSegments, item)` or undefined if falsey.\n\n#####Maps\n\n`mpath.get` also accepts an optional `map` argument which receives each individual found value. The value returned from the `map` function will be used in the original found values place.\n\n```js\nvar obj = {\n    comments: [\n      { title: 'funny' },\n      { title: 'exciting!' }\n    ]\n}\n\nmpath.get('comments.title', obj, function (val) {\n  return 'funny' == val\n    ? 'amusing'\n    : val;\n});\n// ['amusing', 'exciting!']\n```\n\n###Setting\n\n```js\nvar obj = {\n    comments: [\n      { title: 'funny' },\n      { title: 'exciting!' }\n    ]\n}\n\nmpath.set('comments.1.title', 'hilarious', obj)\nconsole.log(obj.comments[1].title) // 'hilarious'\n```\n\n`mpath.set` supports the same array property notation as `mpath.get`.\n\n```js\nvar obj = {\n    comments: [\n      { title: 'funny' },\n      { title: 'exciting!' }\n    ]\n}\n\nmpath.set('comments.title', ['hilarious', 'fruity'], obj);\n\nconsole.log(obj); // prints..\n\n  { comments: [\n      { title: 'hilarious' },\n      { title: 'fruity' }\n  ]}\n```\n\nArray property and indexing syntax can be used together also when setting.\n\n```js\nvar obj = {\n  array: [\n      { o: { array: [{x: {b: [4,6,8]}}, { y: 10} ] }}\n    , { o: { array: [{x: {b: [1,2,3]}}, { x: {z: 10 }}, { x: 'Turkey Day' }] }}\n    , { o: { array: [{x: {b: null }}, { x: { b: [null, 1]}}] }}\n    , { o: { array: [{x: null }] }}\n    , { o: { array: [{y: 3 }] }}\n    , { o: { array: [3, 0, null] }}\n    , { o: { name: 'ha' }}\n  ]\n}\n\nmpath.set('array.1.o', 'this was changed', obj);\n\nconsole.log(require('util').inspect(obj, false, 1000)); // prints..\n\n{\n  array: [\n      { o: { array: [{x: {b: [4,6,8]}}, { y: 10} ] }}\n    , { o: 'this was changed' }\n    , { o: { array: [{x: {b: null }}, { x: { b: [null, 1]}}] }}\n    , { o: { array: [{x: null }] }}\n    , { o: { array: [{y: 3 }] }}\n    , { o: { array: [3, 0, null] }}\n    , { o: { name: 'ha' }}\n  ];\n}\n\nmpath.set('array.o.array.x', 'this was changed too', obj);\n\nconsole.log(require('util').inspect(obj, false, 1000)); // prints..\n\n{\n  array: [\n      { o: { array: [{x: 'this was changed too'}, { y: 10, x: 'this was changed too'} ] }}\n    , { o: 'this was changed' }\n    , { o: { array: [{x: 'this was changed too'}, { x: 'this was changed too'}] }}\n    , { o: { array: [{x: 'this was changed too'}] }}\n    , { o: { array: [{x: 'this was changed too', y: 3 }] }}\n    , { o: { array: [3, 0, null] }}\n    , { o: { name: 'ha' }}\n  ];\n}\n```\n\n####Setting arrays\n\nBy default, setting a property within an array to another array results in each element of the new array being set to the item in the destination array at the matching index. An example is helpful.\n\n```js\nvar obj = {\n    comments: [\n      { title: 'funny' },\n      { title: 'exciting!' }\n    ]\n}\n\nmpath.set('comments.title', ['hilarious', 'fruity'], obj);\n\nconsole.log(obj); // prints..\n\n  { comments: [\n      { title: 'hilarious' },\n      { title: 'fruity' }\n  ]}\n```\n\nIf we do not desire this destructuring-like assignment behavior we may instead specify the `$` operator in the path being set to force the array to be copied directly.\n\n```js\nvar obj = {\n    comments: [\n      { title: 'funny' },\n      { title: 'exciting!' }\n    ]\n}\n\nmpath.set('comments.$.title', ['hilarious', 'fruity'], obj);\n\nconsole.log(obj); // prints..\n\n  { comments: [\n      { title: ['hilarious', 'fruity'] },\n      { title: ['hilarious', 'fruity'] }\n  ]}\n```\n\n####Field assignment rules\n\nThe rules utilized mirror those used on `mpath.get`, meaning we can take values returned from `mpath.get`, update them, and reassign them using `mpath.set`. Note that setting nested arrays of arrays can get unweildy quickly. Check out the [tests](https://github.com/aheckmann/mpath/blob/master/test/index.js) for more extreme examples.\n\n#####Maps\n\n`mpath.set` also accepts an optional `map` argument which receives each individual value being set. The value returned from the `map` function will be used in the original values place.\n\n```js\nvar obj = {\n    comments: [\n      { title: 'funny' },\n      { title: 'exciting!' }\n    ]\n}\n\nmpath.set('comments.title', ['hilarious', 'fruity'], obj, function (val) {\n  return val.length;\n});\n\nconsole.log(obj); // prints..\n\n  { comments: [\n      { title: 9 },\n      { title: 6 }\n  ]}\n```\n\n### Custom object types\n\nSometimes you may want to enact the same functionality on custom object types that store all their real data internally, say for an ODM type object. No fear, `mpath` has you covered. Simply pass the name of the property being used to store the internal data and it will be traversed instead:\n\n```js\nvar mpath = require('mpath');\n\nvar obj = {\n    comments: [\n      { title: 'exciting!', _doc: { title: 'great!' }}\n    ]\n}\n\nmpath.get('comments.0.title', obj, '_doc')            // 'great!'\nmpath.set('comments.0.title', 'nov 3rd', obj, '_doc')\nmpath.get('comments.0.title', obj, '_doc')            // 'nov 3rd'\nmpath.get('comments.0.title', obj)                    // 'exciting'\n```\n\nWhen used with a `map`, the `map` argument comes last.\n\n```js\nmpath.get(path, obj, '_doc', map);\nmpath.set(path, val, obj, '_doc', map);\n```\n\n[LICENSE](https://github.com/aheckmann/mpath/blob/master/LICENSE)\n\n",
  "readmeFilename": "README.md",
  "bugs": {
    "url": "https://github.com/aheckmann/mpath/issues"
  },
  "_id": "mpath@0.1.1",
  "dist": {
    "shasum": "47ae636b53bcd896d0cbfb2ae3bf4877d2930917"
  },
  "_from": "mpath@0.1.1",
  "_resolved": "https://registry.npmjs.org/mpath/-/mpath-0.1.1.tgz"
}
