Skip to main content
Module

x/release_up/deps.ts>ini.encode

🌱 Automate releases
Go to Latest
function ini.encode
import { ini } from "https://deno.land/x/release_up@0.5.0/deps.ts";
const { encode } = ini;

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.

The options object may contain the following:

  • section A string which will be the first section in the encoded ini data. Defaults to none.
  • whitespace Boolean to specify whether to put whitespace around the = character. By default, whitespace is omitted, to be friendly to some persnickety old parsers that don't tolerate it well. But some find that it's more human-readable and pretty with the whitespace.

For backwards compatibility reasons, if a string options is passed, then it is assumed to be the section value.

Parameters

obj: any

Object to encode

optional
opt: string | EncodeOptions = [UNSUPPORTED]

Encoding options