🚧 This project is under development.

Table of Contents

- Installation
- Usage
- Contributing

Installation

Install package:

``sh

npm

npm install js-ini-parser

yarn

yarn add js-ini-parser

pnpm

pnpm install js-ini-parser
`

Import:

`js
// ESM
import { parseIni } from "js-ini-parser";

// CommonJS
const { parseIni } = require("js-ini-parser");
`

Usage

$3

- parseIni(text, options)
- stringifyIni(object, options)

$3

`js
import { parseIni } from "js-ini-parser";

const ini =
[server]
; this is a comment
host =
port = 8080
;

const options = {
allowGlobalSection: true,
globalSectionName: 'global'
}

const parsed = parseIni(ini, options);

console.log(parsed);
`

$3

`ts
import * as fs from "node:fs/promises";
import { parseIni } from "js-ini-parser";


const options = {
allowGlobalSection: true,
globalSectionName: 'global'
}

const fileContent = await fs.readFile("./config.ini", "utf-8");
const parsed = parseIni(fileContent, options);


`

$3

`ts

import { parse, stringify } from "js-ini-parser";

const ini =
[server]
; this is a comment
host =
port = 8080
;

const options = {
allowGlobalSection: true,
globalSectionName: 'global'
}

const parsed = parseIni(ini, options);

// edit object
parsed.server.host = 'localhost'

// convert to text
const text = stringifyIni(parsed, {})


`

Contributing

- Clone this repository
- Install dependencies using pnpm install
- Run interactive tests using pnpm dev`

License

Published under MIT License.


[npm-version-href]: https://npmjs.com/package/js-ini-parser
[npm-downloads-href]: https://npmjs.com/package/js-ini-parser
[npm-version-src]: https://img.shields.io/npm/v/js-ini-parser?style=flat-square
[npm-downloads-src]: https://img.shields.io/npm/dm/js-ini-parser?style=flat-square