• load-ini
  • Installation
  • Usage
    • Nodejs require
    • ES6 module
  • API Reference
    • loadIni
    • loadIniSync
    • parseIni
    • stringifyIni
  • Support & Issues
  • License

Installing

# use pnpm
$ pnpm install load-ini

# use npm
$ npm install load-ini --save
Copy

Usage

1. Nodejs require

const { loadIni, loadIniSync } = require('load-ini')

loadIni('/path/of/ini_file').then(data => {})
loadIniSync('/path/of/ini_file')
Copy

2. ES6 module

import { loadIni, loadIniSync } from 'load-ini'
Copy

API Reference

loadIni

Read and parse a .ini file

• Since: 1.0.0

• Arguments:

Parameters	Description	Type	Optional	Required	Default
path	path of ini file	string	-	true	-

• Returns: object | array

• Example:

loadIni('/path/of/ini_file').then(data => {
  console.log(data)
  // { "name": "saqqdy" }
})
Copy

• Types:

declare function loadIni(path: string): Promise<Record<string, unknown> | unknown[]>
Copy

loadIniSync

Read and parse a .ini file sync mode

• Since: 1.0.0

• Arguments:

Parameters	Description	Type	Optional	Required	Default
path	path of ini file	string	-	true	-

• Returns: object | array

• Example:

loadIniSync('/path/of/ini_file')
// { "name": "saqqdy" }
Copy

• Types:

declare function loadIniSync(path: string): Record<string, unknown> | unknown[]
Copy

parseIni

Parse ini string into object

• Since: 1.0.0

• Arguments:

Parameters	Description	Type	Optional	Required	Default
data	ini string	string	-	true	-

• Returns: object | array

• Example:

parseIni(`
[user]
    name = saqqdy
    age = 18
`)
// { "name": "saqqdy", age: 18 }
Copy

• Types:

declare function parseIni(data: string): Record<string, unknown> | unknown[]
Copy

stringifyIni

Convert objects to ini strings

• Since: 1.0.0

• Arguments:

Parameters	Description	Type	Optional	Required	Default
data	object data	object array	-	true	-

• Returns: string

• Example:

stringifyIni({ name: 'saqqdy', age: 18 })
// [user]
//     name = saqqdy
//     age = 18
Copy

• Types:

declare function stringifyIni<T>(data: T, options?: EncodeOptions): string
Copy

Support & Issues

Please open an issue here.

License

MIT