sendero

> Data Filtering for Humans

why sendero

"sendero" means footpath in Spanish

demo

http://danieljdufour.com/sendero.js/

install

html

or

js
import { get, listPaths } from "sendero";


basic usage

js
data = {
  "agency": "GSA",
  "measurementType": {
    "method": "modules"
  },
  "version": "2.0.0",
  "releases": [
    {
      "name": "usasearch",
      "description": "System now maintained in open repo https://github.com/GSA/search-gov.",
      "permissions": {
        "licenses": null,
        "usageType": "governmentWideReuse"
      },
      "tags": [
        "GSA"
      ]
    },
    // ...
  }
}

`js listPaths(data, 'agency'); [ "agency", "measurementType.method", "releases.contact.email", "releases.description", // ... ]

get(data, 'agency'); ["GSA"]

// get nested properties using dot syntax get(data, 'releases.permissions.licenses.name'); ["CC0 1.0 Universal", "PD", "agpl-3.0", ... ]

// get nested properties using double underscore syntax get(data, 'releases__permissions__licenses__name'); ["CC0 1.0 Universal", "PD", "agpl-3.0", ... ]`

`advanced usage`


clean

Filter out null, undefined, and empty strings.

js
// dirty
get(data, "releases.license", { clean: false }));
[ null, 'https://creativecommons.org/publicdomain/zero/1.0', null, null, ... ]

// clean get(data, "releases.license", { clean: true })); [ 'https://creativecommons.org/publicdomain/zero/1.0', 'https://github.com/GSA/open.gsa.gov/blob/gh-pages/TERMS.md', ... ]`

`unique`


If you only want unique results returned:

js
// default
get(data, 'releases.tags');
["GSA", "GSA", "GSA", ...]

// uniques only get(data, 'releases.tags', { unique: true }); ["GSA","gsa","socialmedia", "mobileapps", ...]`

`sort`


If you want your results sorted

js
get(data, 'releases.tags', { sort: true });
["508", "API", "Bing", "DigitalGovSearch", ...]


separator

By default, sendero tries syntax where the steps are separted by

"." or "__"

.  If you'd like to restrict the syntax or use a custom separator:

js
get(data, 'releases--tags', { sep: '--' });

// accepts releases--tags and releases__tags get(data, 'releases--tags', { sep: ['--', '__'] });`

`stringify`

js
// converts numbers to strings
get(data, "releases.laborHours", { stringify: true, unique: true });
["0", "200", "12345" ]

// convert objects to JSON strings get(data, "releases.permissions", { stringify: true, unique: true }); [ '{"licenses":null,"usageType":"governmentWideReuse"}', '{"licenses":[{"URL":"http://choosealicense.com/licenses/mit/","name":"mit"}],"usageType":"openSource"}', '{"licenses":[{"URL":"http://choosealicense.com/licenses/gpl-3.0/","name":"gpl-3.0"}],"usageType":"openSource"}', '{"licenses":null,"usageType":"openSource"}', // ... ]``