ts-package-starter - v1.3.0
    Preparing search index...

    Interface WadeGilesOptions

    Options for configuring Wade-Giles conversion.

    interface WadeGilesOptions {
        capitalize?: boolean;
        polyphoneMode?: "auto" | "all";
        preserveNonChinese?: boolean;
        separator?: string;
        toneFormat?: ToneFormat;
        urlSafe?: boolean;
    }
    Index

    Properties

    capitalize?: boolean

    Whether to capitalize the first letter of each word.

    false
    
    polyphoneMode?: "auto" | "all"

    Mode for handling polyphones (characters with multiple pronunciations).

    • 'auto': Context-aware selection (default)
    • 'all': Returns all possible readings in alternatives
    'auto'
    
    preserveNonChinese?: boolean

    Whether to preserve non-Chinese characters in the output.

    true
    
    separator?: string

    Separator between syllables.

    '-'
    
    toneFormat?: ToneFormat

    Format for tone markers.

    'superscript'
    
    urlSafe?: boolean

    Whether to produce URL-safe output (ASCII only, no tones, no special chars). When true, forces toneFormat to 'none', removes apostrophes, and converts ü to u.

    false