npmpackage.info

Gathering detailed insights and metrics for @metrichor/jmespath

Other packages similar to @metrichor/jmespath

@metrichor/jmespath-plus

0.5.3

Level-up your JMESPath expressions with lodash functions!

Gathering detailed insights and metrics for @metrichor/jmespath

@metrichor/jmespath - 0.3.1 | npmpackage.info

@metrichor/jmespath

Typescript translation of the jmespath.js package

0.3.1

MPL-2.0

TypeScript

397.62 kB

2.8

Installations

npm install @metrichor/jmespath

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Min. Node Version

>=10.0.0

Node Version

12.22.1

NPM Version

6.14.12 Pull Requests

Open

13

Total

37

Closed

21

Merged

3

Issues

Open

2

Total

6

Closed

4

Releases

Vulnerability fixes and community contributions

v1.0.1

Updated on Mar 16, 2023

Vulnerability fixes

v0.3.1

Updated on Jun 01, 2021

Security updates

v0.3.0

Updated on May 24, 2021

Prune unused packages

v0.2.1

Updated on Feb 10, 2021

Update dependencies to remove security vulnerabilities

v0.2.0

Updated on Feb 10, 2021

Fix type checking for optional arguments

v0.1.10

Updated on Oct 10, 2020

View All 12 releases

Languages

TypeScript

JavaScript

TypeScript (76.09%)

JavaScript (23.91%)

Developer

nanoporetech

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MPL-2.0 License

69 Stars

55 Commits

7 Forks

17 Watchers

11 Branches

8 Contributors

Updated on Mar 26, 2025

Maintainers

View All 8 Contributors

Package Meta Information

Latest Version

0.3.1

Package Id

@metrichor/jmespath@0.3.1

Unpacked Size

397.62 kB

Size

81.78 kB

File Count

NPM Version

6.14.12

Node Version

12.22.1

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

@metrichor/jmespath

@metrichor/jmespath is a typescript implementation of the JMESPath spec.

JMESPath is a query language for JSON. It will take a JSON document as input and transform it into another JSON document given a JMESPath expression.

INSTALLATION

npm install @metrichor/jmespath

USAGE

`search(data: JSONValue, expression: string): JSONValue`

1/* using ES modules */
2import { search } from '@metrichor/jmespath';
3
4
5/* using CommonJS modules */
6const search = require('@metrichor/jmespath').search;
7
8
9search({foo: {bar: {baz: [0, 1, 2, 3, 4]}}}, "foo.bar.baz[2]")
10
11// OUTPUTS: 2
12

In the example we gave the search function input data of {foo: {bar: {baz: [0, 1, 2, 3, 4]}}} as well as the JMESPath expression foo.bar.baz[2], and the search function evaluated 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:

1import { search } from '@metrichor/jmespath';
2
3/* --- EXAMPLE 1 --- */
4
5let JSON_DOCUMENT = {
6  foo: {
7    bar: {
8      baz: [0, 1, 2, 3, 4]
9    }
10  }
11};
12
13search(JSON_DOCUMENT, "foo.bar");
14// OUTPUTS: { baz: [ 0, 1, 2, 3, 4 ] }
15
16
17/* --- EXAMPLE 2 --- */
18
19JSON_DOCUMENT = {
20  "foo": [
21    {"first": "a", "last": "b"},
22    {"first": "c", "last": "d"}
23  ]
24};
25
26search(JSON_DOCUMENT, "foo[*].first")
27// OUTPUTS: [ 'a', 'c' ]
28
29
30/* --- EXAMPLE 3 --- */
31
32JSON_DOCUMENT = {
33  "foo": [
34    {"age": 20},
35    {"age": 25},
36    {"age": 30},
37    {"age": 35},
38    {"age": 40}
39  ]
40}
41
42search(JSON_DOCUMENT, "foo[?age > `30`]");
43// OUTPUTS: [ { age: 35 }, { age: 40 } ]

`compile(expression: string): ExpressionNodeTree`

You can precompile all your expressions ready for use later on. the compile function takes a JMESPath expression and returns an abstract syntax tree that can be used by the TreeInterpreter function

1import { compile, TreeInterpreter } from '@metrichor/jmespath';
2
3const ast = compile('foo.bar');
4
5TreeInterpreter.search(ast, {foo: {bar: 'BAZ'}})
6// RETURNS: "BAZ"
7

EXTENSIONS TO ORIGINAL SPEC

Register you own custom functions

`registerFunction(functionName: string, customFunction: RuntimeFunction, signature: InputSignature[]): void`

Extend the list of built in JMESpath expressions with your own functions.

1  import {search, registerFunction, TYPE_NUMBER} from '@metrichor/jmespath'
2
3
4  search({ foo: 60, bar: 10 }, 'divide(foo, bar)')
5  // THROWS ERROR: Error: Unknown function: divide()
6
7  registerFunction(
8    'divide', // FUNCTION NAME
9    (resolvedArgs) => {   // CUSTOM FUNCTION
10      const [dividend, divisor] = resolvedArgs;
11      return dividend / divisor;
12    },
13    [{ types: [TYPE_NUMBER] }, { types: [TYPE_NUMBER] }] //SIGNATURE
14  );
15
16  search({ foo: 60,bar: 10 }, 'divide(foo, bar)');
17  // OUTPUTS: 6
18

Optional arguments are supported by setting {..., optional: true} in argument signatures

1
2  registerFunction(
3    'divide',
4    (resolvedArgs) => {
5      const [dividend, divisor] = resolvedArgs;
6      return dividend / divisor ?? 1; //OPTIONAL DIVISOR THAT DEFAULTS TO 1
7    },
8    [{ types: [TYPE_NUMBER] }, { types: [TYPE_NUMBER], optional: true }] //SIGNATURE
9  );
10
11  search({ foo: 60, bar: 10 }, 'divide(foo)');
12  // OUTPUTS: 60
13

Root value access with $ symbol

1
2search({foo: {bar: 999}, baz: [1, 2, 3]}, '$.baz[*].[@, $.foo.bar]')
3
4// OUTPUTS:
5// [ [ 1, 999 ], [ 2, 999 ], [ 3, 999 ] ]

More Resources

The example above only show a small amount of what a JMESPath expression can do. If you want to take a tour of the language, the best place to go is the JMESPath Tutorial.

One of the best things about JMESPath is that it is implemented in many different programming languages including python, ruby, php, lua, etc. To see a complete list of libraries, check out the JMESPath libraries page.

And finally, the full JMESPath specification can be found on the JMESPath site.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

3

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

1

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.8

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to @metrichor/jmespath

Other packages similar to @metrichor/jmespath

@metrichor/jmespath

Installations

Developer Guide

Yes

CommonJS

>=10.0.0

12.22.1

6.14.12

Pull Requests

13

37

21

3

Issues

2

6

4

Releases

Languages

Developer

nanoporetech

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

NaN

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

@metrichor/jmespath

INSTALLATION

USAGE

search(data: JSONValue, expression: string): JSONValue

compile(expression: string): ExpressionNodeTree

EXTENSIONS TO ORIGINAL SPEC

Register you own custom functions

registerFunction(functionName: string, customFunction: RuntimeFunction, signature: InputSignature[]): void

Root value access with $ symbol

More Resources

10

10

10

3

1

0

0

0

0

0

0

0

0

2.8

/10

`search(data: JSONValue, expression: string): JSONValue`

`compile(expression: string): ExpressionNodeTree`

`registerFunction(functionName: string, customFunction: RuntimeFunction, signature: InputSignature[]): void`

Root value access with `$` symbol