Skip to content

Commit

Permalink
Added example section to the README and added a contributors property…
Browse files Browse the repository at this point in the history
… in the package.json
  • Loading branch information
Mike Brevoort committed Sep 19, 2011
1 parent 07b9e97 commit 6772d8d
Show file tree
Hide file tree
Showing 2 changed files with 59 additions and 0 deletions.
55 changes: 55 additions & 0 deletions README.md
Expand Up @@ -7,4 +7,59 @@ To evaluate,
var jsonpath = require('JSONPath');
jsonpath.eval(obj, path);

Examples
========

Given the following JSON, taken from http://goessner.net/articles/JsonPath/ :

{ "store": {
"book": [
{ "category": "reference",
"author": "Nigel Rees",
"title": "Sayings of the Century",
"price": 8.95
},
{ "category": "fiction",
"author": "Evelyn Waugh",
"title": "Sword of Honour",
"price": 12.99
},
{ "category": "fiction",
"author": "Herman Melville",
"title": "Moby Dick",
"isbn": "0-553-21311-3",
"price": 8.99
},
{ "category": "fiction",
"author": "J. R. R. Tolkien",
"title": "The Lord of the Rings",
"isbn": "0-395-19395-8",
"price": 22.99
}
],
"bicycle": {
"color": "red",
"price": 19.95
}
}
}


XPath | JSONPath | Result
------------------- | ---------------------- | -------------------------------------
/store/book/author | $.store.book[*].author | the authors of all books in the store
//author | $..author | all authors
/store/* | $.store.* | all things in store, which are some books and a red bicycle.
/store//price | $.store..price | the price of everything in the store.
//book[3] | $..book[2] | the third book
//book[last()] | $..book[(@.length-1)] | the last book in order.
| $..book[-1:] |
//book[position()<3]| $..book[0,1] | the first two books
| $..book[:2] |
//book[isbn] | $..book[?(@.isbn)] | filter all books with isbn number
//book[price<10] | $..book[?(@.price<10)] | filter all books cheapier than 10
//* | $..* |all Elements in XML document. All members of JSON structure.



See http://www.opensource.org/licenses/mit-license.php for license.
4 changes: 4 additions & 0 deletions package.json
Expand Up @@ -2,6 +2,10 @@
"author": "Stefan Goessner",
"name": "JSONPath",
"description": "A JS implementation of JSONPath",
"contributors": [
{ "name": "Stefan Goessner", "email": "subbu@subbu.org" },
{ "name": "Mike Brevoort", "email": "mike@brevoort.com" }
],
"version": "0.8.1",
"repository": {
"type": "git",
Expand Down

0 comments on commit 6772d8d

Please sign in to comment.