@lonu/stc/esm/deps/jsr.io/@std/yaml/1.2.0/stringify.d.ts

A tool for converting OpenApi/Swagger/Apifox into code.

import { type SchemaType } from "./_schema.js";
import type { StyleVariant } from "./_type.js";
export type { SchemaType, StyleVariant };
/** Options for {@linkcode stringify}. */
export type StringifyOptions = {
    /**
     * Indentation width to use (in spaces).
     *
     * @default {2}
     */
    indent?: number;
    /**
     * When true, adds an indentation level to array elements.
     *
     * @default {true}
     */
    arrayIndent?: boolean;
    /**
     * Do not throw on invalid types (like function in the safe schema) and skip
     * pairs and single values with such types.
     *
     * @default {false}
     */
    skipInvalid?: boolean;
    /**
     * Specifies level of nesting, when to switch from block to flow style for
     * collections. `-1` means block style everywhere.
     *
     * @default {-1}
     */
    flowLevel?: number;
    /** Each tag may have own set of styles.	- "tag" => "style" map. */
    styles?: Record<string, StyleVariant>;
    /**
     * Name of the schema to use.
     *
     * @default {"default"}
     */
    schema?: SchemaType;
    /**
     * If true, sort keys when dumping YAML in ascending, ASCII character order.
     * If a function, use the function to sort the keys.
     * If a function is specified, the function must return a negative value
     * if first argument is less than second argument, zero if they're equal
     * and a positive value otherwise.
     *
     * @default {false}
     */
    sortKeys?: boolean | ((a: string, b: string, depth: number) => number);
    /**
     * Set max line width.
     *
     * @default {80}
     */
    lineWidth?: number;
    /**
     * If false, don't convert duplicate objects into references.
     *
     * @default {true}
     */
    useAnchors?: boolean;
    /**
     * If false don't try to be compatible with older yaml versions.
     * Currently: don't quote "yes", "no" and so on,
     * as required for YAML 1.1.
     *
     * @default {true}
     */
    compatMode?: boolean;
    /**
     * If true flow sequences will be condensed, omitting the
     * space between `key: value` or `a, b`. Eg. `'[a,b]'` or `{a:{b:c}}`.
     * Can be useful when using yaml for pretty URL query params
     * as spaces are %-encoded.
     *
     * @default {false}
     */
    condenseFlow?: boolean;
};
/**
 * Converts a JavaScript object or value to a YAML document string.
 *
 * @example Usage
 * ```ts
 * import { stringify } from "@std/yaml/stringify";
 * import { assertEquals } from "@std/assert";
 *
 * const data = { id: 1, name: "Alice" };
 * const yaml = stringify(data);
 *
 * assertEquals(yaml, "id: 1\nname: Alice\n");
 * ```
 *
 * @throws {TypeError} If `data` contains invalid types.
 * @param data The data to serialize.
 * @param options The options for serialization.
 * @returns A YAML string.
 */
export declare function stringify(data: unknown, options?: StringifyOptions): string;
//# sourceMappingURL=stringify.d.ts.map