Git Product home page Git Product logo

deep-object-search's Introduction

deep-object-search

Performs a traversal on a tree object.

Install

npm install deep-object-search --save

Usage

import deepSearch from 'deep-object-search'

let tree = {
  body: {
    data: {
      firstname: 'Norman',
      lastname: 'Carcamo',
      house:399,
      games: {
        console: true,
        gameboy: undefined,
        physic: null
      }
    }
  },
  sports: {
    tennis: true,
    basketball: true,
    football: true,
    rugby: false,
  }
}

deepSearch(tree, 'body.data.games.console')
/* output:
{
  "found": true,
  "search": "body.data.games",
  "value": true,
  "parent": {
    "name": "body",
    "content": {
      "data": {
        "firstname": "Norman",
        "lastname": "Carcamo",
        "house": 399,
        "games": {
          "console": true,
          "physic": null
        }
      }
    }
  },
  "path": "root.body.data.body.data.games"
}
*/

deepSearch(object, path, options)

  • object {Object} The "tree" to search.
  • path {String} Used to search a path or a key name.
  • options {Object} An optional object to change the root key name.
    • rootLabel {String} The name of the first key appended to the end path. Defaults to root.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.