Package description
The ini npm package is used for parsing .ini files and converting objects to .ini format. It provides a simple interface for working with INI configuration files, which are often used for storing settings in a structured yet readable format. This package allows for easy reading, writing, and manipulation of INI files.
Parse INI string
This feature allows you to parse a string in INI format and convert it into a JavaScript object. The example demonstrates parsing a simple INI formatted string.
"const ini = require('ini');\nconst config = ini.parse('[section]\na=1\nb=2');\nconsole.log(config); // { section: { a: '1', b: '2' } }"Stringify an object to INI format
This feature converts a JavaScript object into a string in INI format. The example shows how to convert an object with nested properties into an INI formatted string.
"const ini = require('ini');\nconst obj = { section: { a: '1', b: '2' } };\nconst str = ini.stringify(obj);\nconsole.log(str); // '[section]\na=1\nb=2'"dotenv is a package that loads environment variables from a .env file into process.env. While it serves a different purpose by focusing on environment variables, it shares the concept of managing configuration through a file. Unlike ini, dotenv does not support sections or nested properties.
rc is a configuration package that reads properties from multiple sources, including INI files, environment variables, and command-line arguments. It offers more flexibility in configuration management compared to ini by aggregating settings from various sources, but it might be more complex to use for simple INI file parsing and writing.
config is a more comprehensive configuration management solution that supports multiple file formats, including JSON, YAML, and JavaScript. It is designed for organizing hierarchical configurations for app deployments. While it provides more features and supports more formats than ini, it might be overkill for simple INI file tasks.
Readme
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
[database]
user = dbuser
password = dbpassword
database = use_this_database
[paths.default]
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:
[section]
scope = local
[section.database]
user = dbuser
password = dbpassword
database = use_another_database
[section.paths.default]
tmpdir = /tmp
Decode the ini-style formatted inistring into a nested object.
Alias for decode(inistring)
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.
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
ini.safe('"unsafe string"')
would result in
"\"unsafe string\""
Unescapes the string val
FAQs
An ini encoder/decoder for node
We found that ini demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 6 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.
Security News
Socket is joining forces with CISA and other industry leaders at the RSA Conference to sign the Secure by Design pledge, committing to uphold the highest security standards in our products.
Research
The Socket research team breaks down a sampling of malicious packages that download and execute files, among other suspicious behaviors, targeting the popular Discord platform.