Jq-wasm NPM | npm.io

jq-wasm

jq-wasm is a WebAssembly-powered version of the powerful jq JSON processor, built using Emscripten. It allows you to use jq directly in Node.js or modern browsers without requiring any native dependencies.

Whether you’re filtering, transforming, or querying JSON data, jq-wasm brings the versatility of jq to your JavaScript/TypeScript projects.

🚀 Features

Node.js and Browser Support: Run jq in both server-side and client-side environments.
No Native Dependencies: Works seamlessly without additional libraries or build tools.
Fully Typed: Includes TypeScript definitions for a smooth development experience.
Familiar jq API: Supports standard jq filters and flags.

📦 Installation

Install with npm:

npm install jq-wasm

or with Yarn:

yarn add jq-wasm

🛠️ Usage

const jq = require("jq-wasm");
// or using ES modules:
// import jq from "jq-wasm";

(async () => {
  try {
    // Example JSON input
    const input = { foo: "bar", list: [1, 2, 3] };

    // Using jq.raw for raw text output
    const rawResult = await jq.raw(input, ".list | .[]", ["-c"]);
    console.log(rawResult); // Output: "1\n2\n3"

    // Using jq.json for parsed JSON output
    const result = await jq.json(input, ".foo");
    console.log(result); // Output: ["bar"]
  } catch (err) {
    console.error("Error:", err.message);
  }
})();

📖 API

`jq.raw(input, filter, [flags])`

Executes a jq filter and returns raw string output, exactly as jq would produce.

Parameters

input: A JavaScript object or array (the JSON input).
filter: A jq filter string.
flags (optional): An array of jq command-line flags.

Returns

A Promise that resolves to:

Raw string: The jq output as a plain text string.

`jq.json(input, filter, [flags])`

Executes a jq filter on a JSON object and returns parsed JSON results.

Parameters

input: A JavaScript object or array (the JSON input).
filter: A jq filter string (e.g., .foo, .[].bar, etc.).
flags (optional): An array of jq command-line flags (e.g., ["-c"] for compact output).