# @csv-js/csv

> Main module for processing with Csv.

Latest version **0.0.3** (published 2023-02-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install @csv-js/csv
pnpm add @csv-js/csv
yarn add @csv-js/csv
bun add @csv-js/csv
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2023-02-03 |
| First published | 2023-01-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 9.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | eddieyg |
| Maintainers | eddiezhao |
| Keywords | csv, csvjs, csv-parse, csv-format |

## Links

- npm: https://www.npmjs.com/package/@csv-js/csv
- Repository: https://github.com/eddieyg/csvjs
- Homepage: https://github.com/eddieyg/csvjs#readme
- Issues: https://github.com/eddieyg/csvjs/issues
- npm.io page: https://npm.io/package/@csv-js/csv

## Dependencies (2)

- [@csv-js/core](https://npm.io/package/@csv-js/core.md) ^0.0.1
- [@csv-js/type](https://npm.io/package/@csv-js/type.md) ^0.0.1

## Alternatives

- [csv-to-markdown-table](https://npm.io/package/csv-to-markdown-table.md) — 47.0K weekly downloads
- [@sapphire/ratelimits](https://npm.io/package/@sapphire/ratelimits.md) — 4.4K weekly downloads
- [js-csvparser](https://npm.io/package/js-csvparser.md) — 2.0K weekly downloads
- [@adadapted/js-sdk](https://npm.io/package/@adadapted/js-sdk.md) — 251 weekly downloads
- [@grapecity/spread-sheets-sparklines](https://npm.io/package/@grapecity/spread-sheets-sparklines.md) — 103 weekly downloads

## Recent versions

- 0.0.3 (latest) — 2023-02-03
- 0.0.2 — 2023-01-31
- 0.0.1 — 2023-01-31

## README

# CsvJs
A js library specialized in processing csv data.

## ✨ Features

- Parse csv format
- Serialized csv format
- Csv data CRUD
- Browser download csv

## 📦︎ Packages

- `@csv-js/csv` A class specialized in processing csv data.
- `@csv-js/core` The core module for processing csv.
- `@csv-js/type` Generic types for csv-js packsge.

## 👨‍💻 Usage

### Install

```shell
npm install @csv-js/csv --save
```

### Example

```typescript
import Csv from '@csv-js/csv'

const header = [
  {
    key: 'name',
    label: 'Name'
  },
  {
    key: 'age',
  }
]
const csv = new Csv(header, { name: 'test' })

csv.append([
  {
    name: 'eddie',
    age: 20
  },
  {
    name: 'jojo',
    age: 18
  }
])

csv.toString() // 'Name,age\r\neddie,20\r\njojo,18'

// Browser download csv
csv.download()
```

## 📃 Documentation

To be perfected.

## License

Licensed under the [MIT License](LICENSE).

---
_Source: https://npm.io/package/@csv-js/csv · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._