@alwatr/json2csv

A tiny, efficient, and cross-platform JSON to CSV converter.

Features

- Lightweight: Minimal footprint, zero dependencies (except type helpers).
- Fast: Optimized for performance using array mapping and joining.
- Flexible: Custom delimiters, optional headers, and value replacement support.
- Robust: Handles escaped characters, nested objects, and arrays correctly.
- Type-Safe: Written in TypeScript with full type definitions.

Installation

``bash
yarn add @alwatr/json2csv
`

Usage

`typescript
import { jsonToCsv } from '@alwatr/json2csv';

const data = [
{ name: 'Ali', age: 30, city: 'Tehran' },
{ name: 'John', age: 25, city: 'New York' }
];

const csv = jsonToCsv(data);
console.log(csv);
/*
name,age,city
Ali,30,Tehran
John,25,New York
*/
`

$3

You can customize the output using optional parameters:

`typescript
const csv = jsonToCsv(
data, // Data array
';', // Custom delimiter (default: ',')
false // Include headers (default: true)
);
`

API

$3

Converts a JSON array of objects to a CSV string.

- jsonData: Array