keep-a-changelog/script/deps/jsr.io/@std/ini/0.225.2/stringify.d.ts

Node package to parse and generate changelogs following the [keepachangelog](https://keepachangelog.com/) format.

import { type FormattingOptions, type ReplacerFunction } from "./ini_map.js";
/** Options for constructing INI strings. */
export interface StringifyOptions extends FormattingOptions {
    /** Provide custom string conversion for the value in a key/value pair. */
    replacer?: ReplacerFunction;
}
/**
 * Compile an object into an INI config string. Provide formatting options to modify the output.
 *
 * @example Usage
 * ```ts
 * import { stringify } from "@std/ini/stringify";
 * import { assertEquals } from "@std/assert";
 *
 * const str = stringify({
 *   key1: "value1",
 *   key2: "value2",
 *   section1: {
 *     foo: "bar",
 *   },
 *   section2: {
 *     hello: "world",
 *   },
 * });
 *
 * assertEquals(str, `key1=value1
 * key2=value2
 * [section1]
 * foo=bar
 * [section2]
 * hello=world`);
 * ```
 *
 * @example Using replacer option
 * ```ts
 * import { stringify } from "@std/ini/stringify";
 * import { assertEquals } from "@std/assert";
 *
 * const str = stringify({
 *   "section X": {
 *     date: new Date("2024-06-10"),
 *   },
 *   "section Y": {
 *     name: "John"
 *   }
 * }, {
 *   replacer(key, value, section) {
 *     if (section === "section X" && key === "date") {
 *       return value.toISOString().slice(0, 10);
 *     }
 *     return value;
 *   },
 * });
 *
 * assertEquals(str, `[section X]
 * date=2024-06-10
 * [section Y]
 * name=John`);
 * ```
 *
 * @param object The object to stringify
 * @param options The option to use
 * @returns The INI string
 */
export declare function stringify(object: any, options?: StringifyOptions): string;
//# sourceMappingURL=stringify.d.ts.map