Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Fetching contributors…
Cannot retrieve contributors at this time
72 lines (47 sloc) 1.88 KB

An ini format parser and serializer for node.

Sections are treated as nested objects. Items before the first heading are saved on the object directly.


Consider an ini-file config.ini that looks like this:

; this comment is being ignored
scope = global

user = dbuser
password = dbpassword
database = use_this_database

datadir = /var/lib/data

You can read, manipulate and write the ini-file like so:

var fs = require('fs')
  , ini = require('ini')

var config = ini.parse(fs.readFileSync('./config.ini', 'utf-8'))

config.scope = 'local'
config.database.database = 'use_another_database'
config.paths.default.tmpdir = '/tmp'
delete config.paths.default.datadir

fs.writeFileSync('./config_modified.ini', ini.stringify(config, 'section'))

This will result in a file called config_modified.ini being written to the filesystem with the following content:

scope = local
user = dbuser
password = dbpassword
database = use_another_database
tmpdir = /tmp



Decode the ini-style formatted inistring into a nested object.


Alias for decode(inistring)

encode(object, [section])

Encode the object object into an ini-style formatted string. If the optional parameter section is given, then all top-level properties of the object are put into this section and the section-string is prepended to all sub-sections, see the usage example above.

stringify(object, [section])

Alias for encode(object, [section])


Escapes the string val such that it is safe to be used as a key or value in an ini-file. Basically escapes quotes. For example'"unsafe string"')

would result in

"\"unsafe string\""


Unescapes the string val

Jump to Line
Something went wrong with that request. Please try again.