libtidy/src/options.d.ts

Node bindings to the HTML Tidy library

/**
* Type for libtidy options
* @generated with /util/gen-typescript-decl.ts
*/
export namespace Generated {
  /**
  * NOTE:
  * This definition describes the dictionary as returned by the getters.
  * When setting value, a lot more is technically possible:
  *  - setting enum values by number
  *  - setting boolean values using strings like "yes"
  *  - using CamelCase instead of _ for multi-word option names
  * But none of that is advisable practice in a type-checked setup.
  */
  interface OptionDict {
    accessibility_check?: "0 (Tidy Classic)" | "1 (Priority 1 Checks)" | "2 (Priority 2 Checks)" | "3 (Priority 3 Checks)"
    add_xml_decl?: boolean
    add_xml_space?: boolean
    alt_text?: string
    anchor_as_name?: boolean
    ascii_chars?: boolean
    assume_xml_procins?: boolean
    bare?: boolean
    break_before_br?: boolean
    char_encoding?: "raw" | "ascii" | "latin0" | "latin1" | "utf8" | "iso2022" | "mac" | "win1252" | "ibm858" | "utf16le" | "utf16be" | "utf16" | "big5" | "shiftjis"
    clean?: boolean
    coerce_endtags?: boolean
    css_prefix?: string
    decorate_inferred_ul?: boolean
    doctype?: "html5" | "omit" | "auto" | "strict" | "transitional" | "user"
    doctype_mode?: "html5" | "omit" | "auto" | "strict" | "transitional" | "user"
    drop_empty_elements?: boolean
    drop_empty_paras?: boolean
    drop_font_tags?: boolean
    drop_proprietary_attributes?: boolean
    enclose_block_text?: boolean
    enclose_text?: boolean
    error_file?: string
    escape_cdata?: boolean
    escape_scripts?: boolean
    fix_backslash?: boolean
    fix_bad_comments?: boolean
    fix_uri?: boolean
    force_output?: boolean
    gdoc?: boolean
    gnu_emacs?: boolean
    gnu_emacs_file?: string
    hide_comments?: boolean
    hide_endtags?: boolean
    indent?: "no" | "yes" | "auto"
    indent_attributes?: boolean
    indent_cdata?: boolean
    indent_spaces?: number
    indent_with_tabs?: boolean
    input_encoding?: "raw" | "ascii" | "latin0" | "latin1" | "utf8" | "iso2022" | "mac" | "win1252" | "ibm858" | "utf16le" | "utf16be" | "utf16" | "big5" | "shiftjis"
    input_xml?: boolean
    join_classes?: boolean
    join_styles?: boolean
    keep_time?: boolean
    language?: string
    literal_attributes?: boolean
    logical_emphasis?: boolean
    lower_literals?: boolean
    markup?: boolean
    merge_divs?: "no" | "yes" | "auto"
    merge_emphasis?: boolean
    merge_spans?: "no" | "yes" | "auto"
    ncr?: boolean
    new_blocklevel_tags?: string
    new_empty_tags?: string
    new_inline_tags?: string
    new_pre_tags?: string
    newline?: "LF" | "CRLF" | "CR"
    numeric_entities?: boolean
    omit_optional_tags?: boolean
    output_bom?: "no" | "yes" | "auto"
    output_encoding?: "raw" | "ascii" | "latin0" | "latin1" | "utf8" | "iso2022" | "mac" | "win1252" | "ibm858" | "utf16le" | "utf16be" | "utf16" | "big5" | "shiftjis"
    output_file?: string
    output_html?: boolean
    output_xhtml?: boolean
    output_xml?: boolean
    preserve_entities?: boolean
    punctuation_wrap?: boolean
    quiet?: boolean
    quote_ampersand?: boolean
    quote_marks?: boolean
    quote_nbsp?: boolean
    repeated_attributes?: "keep-first" | "keep-last"
    replace_color?: boolean
    show_body_only?: "no" | "yes" | "auto"
    show_errors?: number
    show_info?: boolean
    show_warnings?: boolean
    skip_nested?: boolean
    slide_style?: string
    sort_attributes?: "none" | "alpha"
    split?: boolean
    strict_tags_attributes?: boolean
    tab_size?: number
    tidy_mark?: boolean
    uppercase_attributes?: boolean
    uppercase_tags?: boolean
    vertical_space?: "no" | "yes" | "auto"
    word_2000?: boolean
    wrap?: number
    wrap_asp?: boolean
    wrap_attributes?: boolean
    wrap_jste?: boolean
    wrap_php?: boolean
    wrap_script_literals?: boolean
    wrap_sections?: boolean
    write_back?: boolean
  }
}