tiny-pinyin/tiny-pinyin.d.ts

convert hanzi to pinyin

declare namespace TinyPinyin {
  interface DICT {
    PINYINS: string[]
    UNIHANS: string[]
    EXCEPTIONS: {
      [code: string]: string
    }
  }
  interface Patcher {
    (DICT: DICT): void
  }
  export function isSupported(force?: boolean): boolean
  export function parse(
    str: string
  ): {
    type: 1 | 2 | 3
    source: string
    target: string
  }[]
  export function convertToPinyin(str: string, separator?: string, lowerCase?: boolean): string
  export function patchDict(patcher: Patcher | Patcher[]): void
}

declare module 'tiny-pinyin' {
  export = TinyPinyin
}