Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 37 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,12 @@ Using jmespath.js is really easy. There's a single function
you use, `jmespath.search`:


```
> var jmespath = require('jmespath');
> jmespath.search({foo: {bar: {baz: [0, 1, 2, 3, 4]}}}, "foo.bar.baz[2]")
2
```js
var jmespath = require('jmespath');

jmespath.search({foo: {bar: {baz: [0, 1, 2, 3, 4]}}}, "foo.bar.baz[2]")

// output: 2
```

In the example we gave the ``search`` function input data of
Expand All @@ -25,20 +27,37 @@ the expression against the input data to produce the result ``2``.
The JMESPath language can do a lot more than select an element
from a list. Here are a few more examples:

```
> jmespath.search({foo: {bar: {baz: [0, 1, 2, 3, 4]}}}, "foo.bar")
{ baz: [ 0, 1, 2, 3, 4 ] }

> jmespath.search({"foo": [{"first": "a", "last": "b"},
{"first": "c", "last": "d"}]},
"foo[*].first")
[ 'a', 'c' ]

> jmespath.search({"foo": [{"age": 20}, {"age": 25},
{"age": 30}, {"age": 35},
{"age": 40}]},
"foo[?age > `30`]")
[ { age: 35 }, { age: 40 } ]
```js
jmespath.search({
foo: {
bar: {
baz: [0, 1, 2, 3, 4]
}
}
}, "foo.bar")

// output: { baz: [ 0, 1, 2, 3, 4 ] }

jmespath.search({
"foo": [
{"first": "a", "last": "b"},
{"first": "c", "last": "d"}
]
}, "foo[*].first")

// output: [ 'a', 'c' ]

jmespath.search({
"foo": [
{"age": 20},
{"age": 25},
{"age": 30},
{"age": 35},
{"age": 40}
]
}, "foo[?age > `30`]")

// ouput: [ { age: 35 }, { age: 40 } ]
```

## More Resources
Expand Down