bai2-parser
Version:
Parse the bai2 statement file as CSV or JSON file
88 lines (48 loc) • 2.2 kB
Markdown
BAI2 Parser is for parsing the bai(Bank Administration Institute) files and convert into the CSV or JSON file.
Check out our documentation below to learn how to get started
## Contents
- [Installation](#-installation)
- [Usage](#-usage)
- [Methods](#-methods)
## 🚀 Installation
1. Install `bai2-parser`:
```bash
npm install bai2-parser
```
```bash
yarn add bai2-parser
```
## 🎉 Usage
Here is a basic example of how to use bai2 parser. By using this, you can read the input directly from file or pass the string.
* `Example with pass the string`
```js
import fs from 'fs'
import { BAI2 } from 'bai2-parser'
const fileString = fs.readFileSync(`./sample.bai`).toString()
// You can get the parsed answer from file string using below prop.
const parsefromString = BAI2.fromString(fileString, { output:'JSON' })
console.log('parsefromString', parsefromString)
```
* `Example with pass the file directly`
```js
import { BAI2 } from 'bai2-parser'
// You can get the parsed answer from file using below prop.
const parsefromFile = BAI2.fromFile(`./sample.bai`, { output:'CSV' })
console.log('parsefromFile', parsefromFile)
```
Returns the JSON or CSV `string` or rejects with an `Error` if there was an issue.
* `fileString` - An fileString of BAI2 file to be converted to JSON or CSV.
* `options` - (Optional) A BAI2 file specifying any of the following key value pairs:
Returns the JSON or CSV `string` or rejects with an `Error` if there was an issue.
* `filePath` - An filePath of BAI2 file to be converted to JSON or CSV.
* `options` - (Optional) A BAI2 file specifying any of the following key value pairs:
| Key | Default | Description |
| -------- | --------------- | ------------------------------------------------ |
| output | 'JSON' \| 'CSV' | You can use this option to customize the output. |
MIT