glob-object

    1.0.0 • Public • Published

    glob-object NPM version NPM monthly downloads NPM total downloads Linux Build Status

    Filter an object using glob patterns and dot notation.

    Install

    Install with npm:

    $ npm install --save glob-object

    Usage

    var globObject = require('glob-object');
     
    globObject('a.*.f', {a: {b: {c: 'd'}, e: {f: 'g'}}});
    //=> { a: { e: { f: 'g' } } }

    Examples

    Given the following object:

    var obj = {
      a: {
        b: {
          c: 'd',
          e: 'f',
          g: 'h',
          i: {j: 'k'},
          l: {g: 'k'}
        },
        i: 'j'
      }
    };

    match properties using wildcards

    globObject('*', obj);
    //=> obj (matches all keys)

    match properties using braces

    globObject('a.*.{c,e}', obj);
    //=> {a: {b: {c: 'd', e: 'f'}}}

    match a nested property using a wildcard

    A single star will match one level of the object:

    globObject('a.*.g', obj);
    //=> {a: {b: {g: 'h'}}}

    match deep properties using globstars

    A double star will match to any depth (note that the single star in the previous example did not match a.b.l.g):

    globObject('a.**.g', obj);
    //=> {a: {b: {g: 'h', l: {g: 'k'}}}}

    About

    Related projects

    Contributing

    Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

    Building docs

    (This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

    To generate the readme, run the following command:

    $ npm install -g verbose/verb#dev verb-generate-readme && verb

    Running tests

    Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

    $ npm install && npm test

    Author

    Jon Schlinkert

    License

    Copyright © 2017, Jon Schlinkert. Released under the MIT License.


    This file was generated by verb-generate-readme, v0.6.0, on June 19, 2017.

    Install

    npm i glob-object

    DownloadsWeekly Downloads

    451

    Version

    1.0.0

    License

    MIT

    Last publish

    Collaborators

    • jonschlinkert