An implementation of JSONPath
npm install jsonpath-js!GitHub License
> [!WARNING]
> This library is still in its initial development stage, so please be aware that the API is subject to change.
An implementation of RFC 9535 JSONPath
You can test JSONPath expressions online at https://jsonpath.com/.
- 100% Compatible with RFC 9535
- Node v20+
- Deno v2+
- Bun v1.2+
``
npm install jsonpath-js
`ts
import { JSONPathJS } from "jsonpath-js";
const query = new JSONPathJS("$.users[*].name");
const result = query.find({
users: [{ name: "John Doe" }, { name: "Jane Doe" }],
});
// [ 'John Doe', 'Jane Doe' ]
console.log(result);
const pathResult = query.paths({
users: [{ name: "John Doe" }, { name: "Jane Doe" }],
});
// [
// { value: "John Doe", path: "$['users'][0]['name']" },
// { value: "Jane Doe", path: "$['users'][1]['name']" },
// ];
console.log(pathResult);
const pathSegmentsResult = query.pathSegments({
users: [{ name: "John Doe" }, { name: "Jane Doe" }],
});
// NOTE: The root node $ is not included in the segments
// [
// { value: "John Doe", segments: ["users", 0, "name"] },
// { value: "Jane Doe", segments: ["users", 1, "name"] },
// ];
console.log(pathSegmentsResult);
``
Please read the contributing guide.