@swagger-api/apidom-json-path
Advanced tools
apidom-json-path is a package that evaluates JSONPath expressions against ApiDOM.
You can install this package via npm CLI by running the following command:
$ npm install @swagger-api/apidom-json-path
Package contains JSONPath evaluation functions for evaluating single or multiple JSONPath expression.
Suited for evaluating single JSONPath expression against ApiDOM.
import { ObjectElement } from '@swagger-api/apidom-core';
import { evaluate } from '@swagger-api/apidom-json-path';
const apidom = new ObjectElement({
a: {
b: [100, 1, 2],
},
});
const result = evaluate('$.a.b[?(@ < 10)]', apidom);
// =>
// [
// NumberElement(1),
// NumberElement(2),
// ]
Suited for evaluating multiple JSONPath expression against the same ApiDOM. Use this function in cases when you have multiple JSONPath expressions that need to be evaluated against single ApiDOM fragment.
import { ObjectElement } from '@swagger-api/apidom-core';
import { evaluateMulti } from '@swagger-api/apidom-json-path';
const apidom = new ObjectElement({
a: {
b: [100, 1, 2],
},
});
const resultMulti = evaluateMulti(['$.a.b[?(@ < 10)]', '$.a.b[?(@ > 10)]'], apidom);
// => returns list of tuples which represents mappings between paths and end point values
// [
// ['$.a.b[?(@ < 10)]', [NumberElement(1), NumberElement(2)]],
// ['$.a.b[?(@ > 10)]', [NUmberElement(100)]],
// ]
If either evaluate or evaluateMulti functions are provided with invalid JSONPath expressions,
they don't throw errors, but they rather return empty list of end point values.
import { ObjectElement } from '@swagger-api/apidom-core';
import { evaluate, evaluateMulti } from '@swagger-api/apidom-json-path';
const apidom = new ObjectElement({
a: {
b: [100, 1, 2],
},
});
const result = evaluate('%~!@U@IU$@', apidom); // => []
const resultMulti = evaluateMulti(['%~!@U@IU$@', 'd*AS&*)(&YR3R'], apidom); // => []
0.79.0 (2023-10-24)
FAQs
Evaluate JSONPath expressions against ApiDOM.
The npm package @swagger-api/apidom-json-path receives a total of 452 weekly downloads. As such, @swagger-api/apidom-json-path popularity was classified as not popular.
We found that @swagger-api/apidom-json-path demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers 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.
Research
Security News
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
Security News
Research
A supply chain attack on Rspack's npm packages injected cryptomining malware, potentially impacting thousands of developers.
Research
Security News
Socket researchers discovered a malware campaign on npm delivering the Skuld infostealer via typosquatted packages, exposing sensitive data.