Security News
ESLint is Now Language-Agnostic: Linting JSON, Markdown, and Beyond
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
This module will take paths in documents which can include nested paths specified by '.'s and can evaluate the path to a value, or can set the value at that path depending on the function called.
$ npm install doc-path
let path = require('doc-path');
document
- Object
- A JSON document that will be iterated over.key
- String
- A path to the existing key whose value will be returned.
a.b
) then be sure to escape the dot with a blackslash (eg. a\\.b
).If the key does not exist, undefined
is returned.
If the object's structure is extremely deep, then an error may be thrown if the maximum call stack size is exceeded while traversing the object.
const path = require('doc-path');
let document = {
Make: 'Nissan',
Model: 'Murano',
Year: '2013',
Specifications: {
Mileage: '7106',
Trim: 'S AWD'
},
Features: [
{
feature: 'A/C',
packages: [
{name: 'Base'},
{name: 'Premium'}
]
},
{
feature: 'Radio',
packages: [
{name: 'Convenience'},
{name: 'Premium'}
]
}
]
};
console.log(path.evaluatePath(document, 'Make'));
// => 'Nissan'
console.log(path.evaluatePath(document, 'Specifications.Mileage'));
// => '7106'
console.log(path.evaluatePath(document, 'Features.feature'));
// => [ 'A/C', 'Radio' ]
console.log(path.evaluatePath(document, 'Features.packages.name'));
// => [ ['Base', 'Premium'], ['Convenience', 'Premium'] ]
document
- Object
- A JSON document that will be iterated over.key
- String
- A path to the existing key whose value will be set.
a.b
) then be sure to escape the dot with a blackslash (eg. a\\.b
).value
- *
- The value that will be set at the given key.If the key does not exist, then the object will be built up to have that path. If no document is provided, an error will be thrown. If the object's structure is extremely deep, then an error may be thrown if the maximum call stack size is exceeded while traversing the object.
const path = require('doc-path');
let document = {
Make: 'Nissan',
Features: [
{ feature: 'A/C' }
]
};
console.log(path.setPath(document, 'Color.Interior', 'Tan'));
/*
{
Make: 'Nissan',
Features: [
{ feature: 'A/C' }
]
Color: {
Interior: 'Tan'
}
}
*/
console.log(path.setPath(document, 'StockNumber', '34567'));
/*
{
Make: 'Nissan',
Features: [
{ feature: 'A/C' }
]
Color: {
Interior: 'Tan'
},
StockNumber: '34567'
}
*/
console.log(path.setPath(document, 'Features.cost', '$0 (Standard)'));
/*
{
Make: 'Nissan',
Features: [
{
feature: 'A/C',
cost: '$0 (Standard)'
}
]
Color: {
Interior: 'Tan'
},
StockNumber: '34567'
}
*/
$ npm test
Note: This requires mocha
, should
, async
, and underscore
.
To see test coverage, please run:
$ npm run coverage
Current Coverage is:
Statements : 100% ( 33/33 )
Branches : 100% ( 24/24 )
Functions : 100% ( 3/3 )
Lines : 100% ( 29/29 )
.
characters (as of v3.0.0)FAQs
A document path library for Node
We found that doc-path demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
Security News
Members Hub is conducting large-scale campaigns to artificially boost Discord server metrics, undermining community trust and platform integrity.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.