Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ofirelarat/text-format-converter
package to convert differents text formats
https://github.com/ofirelarat/text-format-converter
converter csv json xml yaml
Last synced: 3 days ago
JSON representation
package to convert differents text formats
- Host: GitHub
- URL: https://github.com/ofirelarat/text-format-converter
- Owner: ofirelarat
- Created: 2021-12-20T15:53:28.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2022-11-02T19:36:57.000Z (about 2 years ago)
- Last Synced: 2024-04-27T09:29:59.012Z (9 months ago)
- Topics: converter, csv, json, xml, yaml
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/format-cnv
- Size: 22.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# text-format-converter
js package for convert different format of text file
lets say you need yaml configuration and you already have json file with the same data,
just use this package and convert the file to yaml.
## installation
```sh
npm i format-cnv
```
or install globally for cli usage
```sh
npm i -g format-cnv
```
## Code usage
```javascript
const {convertCSVToObject} = require("format-cnv/lib");
const csvObj = convertCSVToObject(`fname,lname
ofir, elarat
fisrtname, lastname`);
console.log(csvObj)
```
### Functions:
| function | description | [input] [output] |
|-------------------------|--------------------------------------|--------------------|
| convertCSVToObject | convert csv string format to object | [string] [object] |
| convertObjectToCSV | convert object to csv string foramt | [object] [string] |
| convetXMLToObject | convert xml string format to object | [string] [object] |
| convertObjectToXML | convert object to xml string foramt | [object] [string] |
| convetYAMLToObject | convert yaml string format to object | [string] [object] |
| convertObjectToYAML | convert object to yaml string foramt | [object] [string] |
| convertJSONToObject | convert json string format to object | [string] [object] |
| convertObjectToJSON | convert object to json string foramt | [object] [string] |
| convertb64ToUTF8 | convert base64 string UTF8 object | [string] [string] |
| convertTextToBase64 | convert string to base64 string | [string] [string] |
## CLI usage
```sh
Usage: -i -it -o -ot
```
| ALIAS | DESCRIPTION | TYPE |
|-------------------------|-----------------------------------|----------------------------|
| --help | Show help | [boolean] |
| --version | Show version number | [boolean] |
| -i, --inputFile | input file path | [string] [required] |
| --it, --inputType | input file type: JSON/YAML/XML.. | [string] [required] |
| -o, --outputFile | output file path | [string] {console if null} |
| --ot, --outputType | output file type: JSON/YAML/XML..| [string] [required] |
The supported format for now are:
- JSON
- XML
- YAML
- CSV
### Examples:
- JSON To YAML
> format-cnv -i /sample.json --it JSON -o /output.yaml --ot YAML
- JSON To XML
> format-cnv -i /sample.json --it JSON -o /output.xml --ot XML
- YAML To JSON
> format-cnv -i /sample.yaml --it YAML -o /output.json --ot JSON