excel-csv-read-write/README.md

Excel and CSV read write utility.

<p>
  <a href="https://www.npmjs.com/package/excel-csv-read-write" target="_blank">
    <img alt="Version" src="https://img.shields.io/npm/v/excel-csv-read-write.svg">
  </a>
  <a href="https://github.com/masatomix/excel-csv-read-write#readme" target="_blank">
    <img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" />
  </a>
  <a href="https://github.com/masatomix/excel-csv-read-write/graphs/commit-activity" target="_blank">
    <img alt="Maintenance" src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" />
  </a>
  <a href="https://github.com/masatomix/excel-csv-read-write/blob/master/LICENSE" target="_blank">
    <img alt="License: Apache--2.0" src="https://img.shields.io/github/license/masatomix/excel-csv-read-write" />
  </a>
</p>

<p><img alt="Node.js CI" src="https://github.com/masatomix/excel-csv-read-write/workflows/Node.js%20CI/badge.svg?branch=master" /></p>





## Revision history

改訂履歴
- 0.2.5 ヘッダ生成時、前後のスペースをトリムする処理を追加。
- 0.2.4 Loggerを変更(bunyan → pino)、ArrayBufferを受け取るメソッドを追加( excelBuffer2json )、その他。
  - linter、formatter、tsconfig あたりを整理。
  - yarn から pnpm へ変更。
  - もろもろconfigファイルたちを変更
- 0.2.3 json2workbook メソッドに以下のパラメタを追加。元のヘッダ名で指定したロジックでソートしたり、ヘッダを変換できるようにした。
    - headerConverter?: (headings: string[]) => unknown[] // ヘッダを変換する関数
    - columnSortOrder?: (a: string, b: string) => number // 列をソートする関数
- 0.2.2 JSONデータをExcelに出力する際、一つ目のJSONデータからヘッダ列を作っていたけど、全データのプロパティを足し合わすことにした
- 0.2.1 Optionに、columnStartIndex: number,columnEndIndex: number, useHeader: boolean を導入
    - useHeaderがfalseの時は、1行目をヘッダとして扱うのでなくデータとして扱うように。レコードのプロパティはIndex番号にする(default値はtrue)
    - useHeaderがfalseの時に、列番号のstart/end を指定して抽出できるようにした(0始まり、どちらかだけの指定も可能)
- 0.2.0
    - Objectを引数にとるメソッドを作成。optionを渡せるようにし、startIndexなどで読み込み開始行を指定できるようにした <br />
      export const excel2json2: (props: ExcelProps) => Promise<unknown[]> <br />
      export const csv2json2: (props: CSVProps) => Promise<unknown[]>  <br />
    
```typescript
const results: unknown[] = await excel2json2({ filePath: 'target.xlsx', option: { startIndex: 3 } }) 
// 4行目をヘッダ列として、その下から取得。(指定しないとstartIndex = 0 の意味)
console.table(results)
```

- 0.1.11 内部のリファクタリングと、下記の対応
    - createWorkbook、toFileAsync、json2workbook メソッド追加
    - Excel書き出し時、指定したシート名がなかったときに、シートを追加する処理がなかったので追加。
    - 引数名見直し
- 0.1.9  TypeScriptをなるべく使うように修正中
- 0.1.3  処理の調整
- 0.1.2  Streamを処理できるよう処理変更
- 0.1.1  初版作成



## Contributing

Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](https://github.com/masatomix/excel-csv-read-write/issues).

## Show your support

Give a ⭐️ if this project helped you!

## License

Copyright © 2023 [Masatomi KINO](https://github.com/masatomix).<br />
This project is [Apache--2.0](https://github.com/masatomix/excel-csv-read-write/blob/master/LICENSE) licensed.

***
_This README was generated by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_