npmpackage.info

Gathering detailed insights and metrics for @remy/node-jq

Other packages similar to @remy/node-jq

nodemon

3.1.7

Simple monitor script for use during development of a Node.js app.

node-jq

6.0.1

Run jq in node

json

11.0.0

a 'json' command for massaging and processing JSON on the command line

snyk-filter

1.3.2

Module to consume json output from Snyk CLI for advanced filtering and results display

Gathering detailed insights and metrics for @remy/node-jq

@remy/node-jq

node-jq is a node wrapper for jq

1.1.7

MIT

JavaScript

3,297 1.7

Installations

npm install @remy/node-jq

Pull Requests

Open

0

Total

0

Closed

0

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Developer

remy

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

No

Node Version

10.14.1

NPM Version

6.4.1 Statistics

216 Commits

3 Watching

4 Branches

1 Contributors

Updated on 09 Aug 2018

Languages

JavaScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

3,297

Last day

Compared to previous day

Last week

-50%

Compared to previous week

Last month

-82.4%

Compared to previous month

Last year

-30.9%

311

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

node-jq is a wrapper for jq - a lightweight and flexible command-line JSON processor.

Installation

1npm install node-jq --save

Usage

jq example

Usually in your CLI with jq you would run:

1jq ".abilities[].moves" bulbasaur.json

and you would get

1{
2  "name": "heartgold-soulsilver",
3  "power": "10"
4}
5{
6  "name": "platinum",
7  "power": "50"
8}
9{
10  "name": "diamond-pearl",
11  "power": "99"
12}

node-jq equivalent

With node-jq you could run it programmatically and interact with the output as a JavaScript Object:

1const jq = require('node-jq')
2
3const filter = '.abilities[].moves'
4const jsonPath = '/path/to/bulbasaur.json'
5const options = {}
6
7jq.run(filter, jsonPath, options)
8  .then((output) => {
9    console.log(output)
10    /*
11      {
12        "name": "heartgold-soulsilver",
13        "power": "10"
14      },
15      {
16        "name": "platinum",
17        "power": "50"
18      },
19      {
20        "name": "diamond-pearl",
21        "power": "99"
22      }
23    */
24  })
25  .catch((err) => {
26    console.error(err)
27    // Something went wrong...
28  })

Options

input

Description	Type	Values	Default
Type of input	string	`'file'`, `'json'`, `'string'`	`'file'`

`input: 'file'`

Run the jq query against a JSON file.

1jq.run('.', '/path/to/file.json').then(console.log)
2// {
3//   "foo": "bar"
4// }

`input: 'file'`

Run jq query against multiple JSON files.

1jq.run('.', ['/path/to/file.json','path/to/other_file.json']).then(console.log)
2// {
3//   "foo": "bar"
4// }
5// {
6//   "otherFoo": "andBar"
7// }

`input: 'json'`

Run the jq query against an Object.

1jq.run('.', { foo: 'bar' }, { input: 'json' }).then(console.log)
2// {
3//   "foo": "bar"
4// }

`input: 'string'`

Run the jq query against a String.

1jq.run('.', '{ foo: "bar" }', { input: 'string' }).then(console.log)
2// {
3//   "foo": "bar"
4// }

output

Description	Values	Default
Type of output	`'pretty'`, `'json'`, `'compact'`, `'string'`	`'pretty'`

`output: 'pretty'`

Return the output as a String.

1jq.run('.', '/path/to/file.json', { output: 'string' }).then(console.log)
2// {
3//   "foo": "bar"
4// }

`output: 'json'`

Return the output as an Object.

1jq.run('.', '/path/to/file.json', { output: 'json' }).then(console.log)
2// { foo: 'bar' }

`output: 'compact'|'string'`

Return the output as a String.

1jq.run('.', '/path/to/file.json', { output: 'compact' }).then(console.log)
2// {"foo":"bar"}
3jq.run('.', '/path/to/file.json', { output: 'string' }).then(console.log)
4// {"foo":"bar"}

slurp

Description	Values	Default
Read input stream into array	`true`, `false`	`false`

`slurp: true`

Read input stream into array.

1jq.run('.', ['/path/to/file.json','/path/to/other_file.json'], { output: 'json', slurp: true }).then(console.log)
2// [
3//   {
4//     "foo": "bar"
5//   },
6//   {
7//     "otherFoo": "andBar"
8//   }
9// ]

sort

Description	Values	Default
Sort object keys in alphabetical order	`true`, `false`	`false`

`sort: true`

Sorts object keys alphabetically.

1jq.run('.', ['/path/to/file.json'], { output: 'json', sort: true }).then(console.log)
2// {
3//   "a": 2,
4//   "b": 1
5// },

Projects using node-jq

atom-jq: an Atom package for manipulating JSON
json-splora: an Electron implementation for manipulating JSON

Why?

Why would you want to manipulate JavaScript Objects with jq syntax in a node app, when there are tools like lodash? The idea was to port jq in node to be able to run it as-is. node-jq doesn't try to replace Object filters, maps, or transformations.

Our primary goal was to make jq syntax available in Atom with atom-jq.

Other than that, jq is an interesting CLI tool to quickly parse the response of an API, such as:

1curl 'https://jsonplaceholder.typicode.com/comments' | jq '.[].postId'

There are also people dealing with complex responses:

Want to learn `jq`?

Seems hard to learn, but it really isn't.

jq is like sed for JSON. Slice, filter, map and transform structured data in a simple and powerful way.

Take a look at this great introduction or a jq lesson.

You can check out the official manual and fiddle around in the online playground jqplay.org.

License

MIT

No vulnerabilities found.

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.

0

SAST

Determines if the project uses static code analysis.

0

Maintained

Determines if the project is "actively maintained".

0

Code-Review

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

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

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

107 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-6chw-6frg-f759
Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
Warn: Project is vulnerable to: GHSA-8w4h-3cm3-2pm2
Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-pp7h-53gx-mx7r
Warn: Project is vulnerable to: GHSA-832h-xg76-4gv6
Warn: Project is vulnerable to: GHSA-cwfw-4gq5-mrqx
Warn: Project is vulnerable to: GHSA-g95f-p29q-9xw4
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-rq8g-5pc5-wrhr
Warn: Project is vulnerable to: GHSA-9vvw-cc9w-f27h
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-qgfr-5hqp-vrw9
Warn: Project is vulnerable to: GHSA-hr2v-3952-633q
Warn: Project is vulnerable to: GHSA-h6ch-v84p-w6p9
Warn: Project is vulnerable to: GHSA-ff7x-qrg7-qggm
Warn: Project is vulnerable to: GHSA-qrmc-fj45-qfc2
Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
Warn: Project is vulnerable to: MAL-2023-462
Warn: Project is vulnerable to: GHSA-xf7w-r453-m56c
Warn: Project is vulnerable to: GHSA-4q6p-r6v2-jvc5
Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
Warn: Project is vulnerable to: GHSA-q42p-pg8m-cqh6
Warn: Project is vulnerable to: GHSA-w457-6q6x-cgp9
Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f
Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p
Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv
Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8
Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65
Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh
Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
Warn: Project is vulnerable to: GHSA-44pw-h2cw-w3vq
Warn: Project is vulnerable to: GHSA-jp4x-w63m-7wgm
Warn: Project is vulnerable to: GHSA-c429-5p7v-vgjp
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j
Warn: Project is vulnerable to: GHSA-pc5p-h8pf-mvwp
Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
Warn: Project is vulnerable to: GHSA-4hpf-3wq7-5rpr
Warn: Project is vulnerable to: GHSA-f522-ffg8-j8r6
Warn: Project is vulnerable to: GHSA-p9w8-2mpq-49h9
Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546
Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-282f-qqgm-c34q
Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp
Warn: Project is vulnerable to: GHSA-fvqr-27wr-82fm
Warn: Project is vulnerable to: GHSA-4xc9-xhrj-v574
Warn: Project is vulnerable to: GHSA-x5rq-j2xg-h7qm
Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695
Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-xf5p-87ch-gxw2
Warn: Project is vulnerable to: GHSA-5v2h-r2cx-5xgj
Warn: Project is vulnerable to: GHSA-rrrm-qjm4-v8hf
Warn: Project is vulnerable to: GHSA-4xcv-9jjx-gfj3
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m / GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-fhjf-83wg-r2j9
Warn: Project is vulnerable to: GHSA-w9mr-4mfr-499f
Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g
Warn: Project is vulnerable to: GHSA-w7rc-rwvf-8q5r
Warn: Project is vulnerable to: GHSA-4p35-cfcx-8653
Warn: Project is vulnerable to: GHSA-7f3x-x4pr-wqhj
Warn: Project is vulnerable to: GHSA-jpp7-7chh-cf67
Warn: Project is vulnerable to: GHSA-q6wq-5p59-983w
Warn: Project is vulnerable to: GHSA-j9fq-vwqv-2fm2
Warn: Project is vulnerable to: GHSA-pqw5-jmp5-px4v
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-g6ww-v8xp-vmwg
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-6g33-f262-xjp4
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-r2j6-p67h-q639
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-44c6-4v22-4mhx
Warn: Project is vulnerable to: GHSA-4x5v-gmq8-25ch
Warn: Project is vulnerable to: GHSA-jv35-xqg7-f92r
Warn: Project is vulnerable to: GHSA-4g88-fppr-53pp
Warn: Project is vulnerable to: GHSA-4jqc-8m5r-9rpr
Warn: Project is vulnerable to: GHSA-2m39-62fm-q8r3
Warn: Project is vulnerable to: GHSA-mf6x-7mm4-x2g7
Warn: Project is vulnerable to: GHSA-j44m-qm6p-hp7m
Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-g7q5-pjjr-gqvp
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
Warn: Project is vulnerable to: GHSA-38fc-wpqx-33j7
Warn: Project is vulnerable to: GHSA-xc7v-wxcw-j472
Warn: Project is vulnerable to: GHSA-662x-fhqg-9p8v
Warn: Project is vulnerable to: GHSA-394c-5j6w-4xmx
Warn: Project is vulnerable to: GHSA-78cj-fxph-m83p
Warn: Project is vulnerable to: GHSA-fhg7-m89q-25r3
Warn: Project is vulnerable to: GHSA-cf4h-3jhx-xvhq
Warn: Project is vulnerable to: GHSA-v4rh-8p82-6h5w
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp

Score

1.7

/10

Last Scanned on 2024-11-18

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 @remy/node-jq

Other packages similar to @remy/node-jq

@remy/node-jq

Installations

Pull Requests

0

0

0

Issues

0

0

0

Releases

Unable to fetch releases

Developer

remy

Developer Guide

CommonJS

No

10.14.1

6.4.1

Statistics

Languages

Total Downloads

3,297

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

Installation

Usage

jq example

node-jq equivalent

Options

input

input: 'file'

input: 'file'

input: 'json'

input: 'string'

output

output: 'pretty'

output: 'json'

output: 'compact'|'string'

slurp

slurp: true

sort

sort: true

Projects using node-jq

Why?

Want to learn jq?

License

10

10

0

0

0

0

0

0

0

0

1.7

/10

`input: 'file'`

`input: 'file'`

`input: 'json'`

`input: 'string'`

`output: 'pretty'`

`output: 'json'`

`output: 'compact'|'string'`

`slurp: true`

`sort: true`

Want to learn `jq`?