JSPM

dot-finder

0.0.1
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • 0
  • Score
    100M100P100Q25623F
  • License MIT

dot-finder is using powerful dot notation to get values in JSON object

Package Exports

  • dot-finder

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (dot-finder) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

dot-finder

Build Status npm version

dot-finder is using powerful dot notation to get values in JSON object

Table of Contents

Install

$ npm install dot-finder

Usage

const dot = require("dot-finder");


/**
 * Object
 */

dot({ foo: { bar: "baz" } }, "foo.bar");
// or
dot({ foo: { bar: "baz" } }, "foo['bar']");
// => "baz"

dot({ "foo.bar": { baz: "hoge" } }, "foo\\.bar.baz");
// => "hoge"

dot({}, "notfound", "defaultValue");
// => "defaultValue"


/**
 * Array
 */

dot([[{ fruits: "apple" }, { fruits: "pineapple" }]], "[0][1].fruits");
// or
dot([[{ fruits: "apple" }, { fruits: "pineapple" }]], "0.1.fruits");
// => "pineapple"


/**
 * Advanced
 */

const data1 = {
  authors: [
    { username: "tsuyoshiwada", profile: { age: 24 } },
    { username: "sampleuser", profile: { age: 30 } },
    { username: "foobarbaz", profile: { age: 33 } }
  ]
};

dot(data1, "authors.*.username");
// => ["tsuyoshiwada", "sampleuser", "foobarbaz"]

dot(data1, "authors.*.profile.age");
// => [24, 30, 33]


const data2 = [
  {
    posts: {
      tags: [
        { id: 1, slug: "news" },
        { id: 2, slug: "sports" },
        { id: 3, slug: "entertaiment" }
      ]
    }
  },
  {
    posts: {
      tags: [
        { id: 4, slug: "music" },
        { id: 5, slug: "it" },
        { id: 6, slug: "programming" }
      ]
    }
  }
];

dot(data2, "*.posts.tags.*.slug");
// => ["news", "sports", "entertaiment", "music", "it", "programming"]

Contribute

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

License

MIT © tsuyoshiwada