@ssh/audiosalad-xml - v1.0.1
    Preparing search index...

    Interface BuildOptions

    interface BuildOptions {
        indent?: string | false;
        onIllegalChars?: "error" | "strip";
        validate?: boolean;
        xmlDeclaration?: boolean;
    }

    Hierarchy

    • SerializeOptions
      • BuildOptions
    Index
    indent?: string | false

    Indent string, or false for a single line. Default four spaces.

    onIllegalChars?: "error" | "strip"

    What to do with characters XML cannot represent. 'error' reports an issue; 'strip' removes them. Default 'error'.

    validate?: boolean

    Suppress the AudioSaladValidationError that invalid input would otherwise raise. Default true (validate and throw).

    This does not mean "emit whatever you were given". A value that cannot be formatted at all — a malformed date, a non-integer where the schema wants xs:unsignedInt, a string holding a character XML cannot represent — is still omitted from the output, because there is nothing legal to write. Facet violations (a bad ISRC, a short UPC) are emitted. Use this to inspect partial output while debugging, not to bypass the schema.

    xmlDeclaration?: boolean

    Emit <?xml version="1.0" encoding="UTF-8"?>. Default true.