@types/ini

What is @types/ini?

@types/ini provides TypeScript type definitions for the ini package, which is used to parse and stringify INI configuration files.

What are @types/ini's main functionalities?

Parsing INI files

This feature allows you to parse INI files into JavaScript objects. The code sample reads an INI file and parses its content into a JavaScript object.

const ini = require('ini');
const fs = require('fs');
const config = ini.parse(fs.readFileSync('./config.ini', 'utf-8'));
console.log(config);

Stringifying JavaScript objects to INI format

This feature allows you to convert JavaScript objects into INI formatted strings. The code sample demonstrates how to stringify a JavaScript object into an INI string.

const ini = require('ini');
const config = {
  section: {
    key: 'value'
  }
};
const iniString = ini.stringify(config);
console.log(iniString);

Other packages similar to @types/ini

ini

The ini package is the core library for parsing and stringifying INI files. It provides the same functionalities as @types/ini but without TypeScript type definitions.

config

The config package is a configuration manager for Node.js applications. It supports multiple configuration file formats, including INI, JSON, and YAML. It offers more features and flexibility compared to @types/ini.

dotenv

The dotenv package loads environment variables from a .env file into process.env. While it primarily deals with .env files, it can be used for simple key-value configuration similar to INI files. It is more focused on environment variables than general configuration.

README

Installation

npm install --save @types/ini

Summary

This package contains type definitions for ini (https://github.com/npm/ini).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ini.

index.d.ts

interface EncodeOptions {
    align?: boolean;
    section?: string;
    sort?: boolean;
    whitespace?: boolean;
    newline?: boolean;
    platform?: string;
    bracketedArray?: boolean;
}

export function decode(str: string): {
    [key: string]: any;
};
export function parse(str: string): {
    [key: string]: any;
};
export function encode(object: any, options?: EncodeOptions | string): string;
export function stringify(object: any, options?: EncodeOptions | string): string;
export function safe(val: string): string;
export function unsafe(val: string): string;

Additional Details

• Last updated: Wed, 27 Dec 2023 07:35:34 GMT
• Dependencies: none

Credits

These definitions were written by Marcin Porębski, Chris Arnesen, and Adaline Simonian.