1.0.2 • Published 3 years ago

@kaspernj/object-digger v1.0.2

Weekly downloads
585
License
ISC
Repository
github
Last release
3 years ago

object-digger

Usage

dig

Traverses through objects to find the given path.

const myObject = {
  people: [
    {
      firstName: "Kasper",
      lastName: "Nielsen"
    }
  ]
}

dig(myObject, "people", 0, "firstName") //=> "Kasper"
dig(myObject, "people", 1, "firstName") //=> null

digg

This functions like dig but it will fail if one of the keys isn't found.

const myObject = {
  people: [
    {
      firstName: "Kasper",
      lastName: "Nielsen"
    }
  ]
}

digg(myObject, "people", 0, "firstName") //=> "Kasper"
digg(myObject, "people", 1, "firstName") //=> Fails because 1 isn't found in the people array

digs

This will fail is object doesn't contain keys named firstKey and secondKey.

const {firstKey, secondKey} = digs(object, "firstKey", "secondKey")