README.md

jsonweaver

jsonweaver is a powerful and easy-to-use library for transforming JSON data into popular formats such as CSV, XML, Markdown tables, YAML, and JSONLines (NDJSON).

Features

• 🚀 Convert to CSV: Easily transform JSON arrays into CSV files, with optional header mapping and nested object flattening.
• 📄 Generate Markdown tables: Convert JSON arrays into neatly formatted Markdown tables.
• 📂 Convert to XML: Transform JSON objects into well-structured XML.
• 📜 Convert to YAML: Seamlessly transform JSON into YAML format for configuration files and more.
• 📦 Convert to JSONLines (NDJSON): Convert JSON arrays to JSONLines format for large-scale data processing and streaming.
• 🔧 Compatible with JavaScript and TypeScript: Ideal for modern projects.

Installation

Install using npm:

npm install jsonweaver

Or using Yarn:

yarn add jsonweaver

Usage

Importing

Javascript

const { jsonweaver } = require("jsonweaver");

TypeScript

import { jsonweaver } from "jsonweaver";

Examples

JSON to CSV (Basic usage, no custom headers, no flatten):

const json = [
  { name: "Alice", age: 25 },
  { name: "Bob", age: 30 },
];

const csv = jsonweaver.toCSV(json);
console.log(csv);

Using custom headers (To rename the keys in the CSV "e.g., name → Full Name, age → Years"):

const headerMapping = {
  name: "Full Name",
  age: "Years",
};

const csvWithHeaders = jsonweaver.toCSV(json, headerMapping);
console.log(csvWithHeaders);
/*
  "Full Name","Years"
  "Alice",25
  "Bob",30
*/

Flatten nested objects (If the JSON contains nested objects, for instance):

const json = [
  { name: "Alice", details: { age: 25, city: "Wonderland" } },
  { name: "Bob", details: { age: 30, city: "Gotham" } },
];

Then toCSV can transform nested fields into separate columns:

const csvFlattened = jsonweaver.toCSV(json, headerMapping, { flatten: true });
console.log(csvFlattened);
/*
  "name","details.age","details.city"
  "Alice",25,"Wonderland"
  "Bob",30,"Gotham"
*/

JSON to XML

const json = { name: "Alice", age: 25, city: "Wonderland" };

const xml = jsonweaver.toXML(json);
console.log(xml);

JSON to Markdown Table

const json = [
  { name: "Alice", age: 25 },
  { name: "Bob", age: 30 },
];

const markdownTable = jsonweaver.toMarkdownTable(json);
console.log(markdownTable);

JSON to YAML

const json = { name: "Alice", age: 25, city: "Wonderland" };

const yaml = jsonweaver.toYaml(json);
console.log(yaml);
/*
name: Alice
age: 25
city: Wonderland
*/

JSON to JSONLines (NDJSON)

const json = [
  { name: "Alice", age: 25 },
  { name: "Bob", age: 30 },
];

const jsonLines = jsonweaver.toJsonLines(json);
console.log(jsonLines);
/*
{"name":"Alice","age":25}
{"name":"Bob","age":30}
*/

JSON to JSONLines Stream

const json = [
  { name: "Alice", age: 25 },
  { name: "Bob", age: 30 },
];

const stream = jsonweaver.toJsonLinesStream(json);

stream.on("data", (chunk) => {
  console.log(chunk.toString());
});

stream.on("end", () => {
  console.log("Stream ended.");
});

API

Function	Description
toCSV(json: object[], headerMap?, opts?)	Converts an array of JSON objects into a CSV string. Supports optional header mapping and nested object flattening.
toXML(json: object)	Converts a JSON object into an XML string.
toMarkdownTable(json: object[])	Converts an array of JSON objects into a formatted Markdown table.
toYaml(json: object)	Converts a JSON object into a YAML string.
toJsonLines(json: object[])	Converts an array of JSON objects into JSONLines (NDJSON) format.
toJsonLinesStream(json: object[])	Creates a readable stream of JSONLines from an array of JSON objects.

headerMap: is an object mapping JSON keys to custom column labels. opts?.flatten: is a boolean indicating whether to flatten nested objects.

Requirements

• Node.js version 14.0.0 or higher.

Contribution

Feel free to open issues or submit pull requests to improve jsonweaver. All contributions are welcome! 🌟

1. Fork the repository.
2. Create a branch for your feature: git checkout -b my-feature.
3. Make your changes and commit: git commit -m 'My awesome feature'.
4. Push to the repository: git push origin my-feature.
5. Open a pull request on GitHub.

License

This project is licensed under the terms of the MIT License.