/** * 面区点情報 * @typedef {Object} _MenKuTen_ * @property {string} [text] 面-区-点 * @property {number} [men=1] 面 * @property {number} ku 区 * @property {number} ten 点 */ declare type _MenKuTen_ = { text?: string; men?: number; ku: number; ten: number; }; /** * 日本語を扱うための様々な機能を提供します */ declare class MojiJS { /** * 文字列からバイナリ配列にエンコードする * @param {String} text - 変換したいテキスト * @param {String} charset - キャラセット(UTF-8/16/32,Shift_JIS,Windows-31J,Shift_JIS-2004,EUC-JP,EUC-JP-2004) * @param {boolean} [is_with_bom=false] - BOMをつけるかどうか * @returns {Array} バイナリ配列(失敗時はnull) */ static encode(text: string, charset: string, is_with_bom?: boolean): number[]; /** * バイナリ配列から文字列にデコードする * @param {Array} binary - 変換したいバイナリ配列 * @param {String} [charset="autodetect"] - キャラセット(UTF-8/16/32,Shift_JIS,Windows-31J,Shift_JIS-2004,EUC-JP,EUC-JP-2004) * @returns {String} 変換した文字列（失敗したらnull） */ static decode(binary: number[], charset?: string): string; /** * サロゲートペア対応のコードポイント取得 * @param {String} text - 対象テキスト * @param {Number} [index = 0] - インデックス * @returns {Number} コードポイント */ static codePointAt(text: string, index?: number): number; /** * コードポイントの数値データを文字列に変換 * @param {...(number|Array)} codepoint - 変換したいコードポイントの数値配列、又は数値を並べた可変引数 * @returns {String} 変換後のテキスト */ static fromCodePoint(...codepoint: (number | number[])[]): string; /** * コードポイント換算で文字列数をカウント * @param {String} text - 対象テキスト * @param {Number} [beginIndex=0] - 最初のインデックス（省略可） * @param {Number} [endIndex] - 最後のインデックス（ここは含めない）（省略可） * @returns {Number} 文字数 */ static codePointCount(text: string, beginIndex?: number, endIndex?: number): number; /** * 文字列をUTF32(コードポイント)の配列に変換 * @param {String} text - 変換したいテキスト * @returns {Array} UTF32(コードポイント)のデータが入った配列 */ static toUTF32Array(text: string): number[]; /** * UTF32の配列から文字列に変換 * @param {Array} utf32 - 変換したいテキスト * @returns {String} 変換後のテキスト */ static fromUTF32Array(utf32: number[]): string; /** * 文字列をUTF16の配列に変換 * @param {String} text - 変換したいテキスト * @returns {Array} UTF16のデータが入った配列 */ static toUTF16Array(text: string): number[]; /** * UTF16の配列から文字列に変換 * @param {Array} utf16 - 変換したいテキスト * @returns {String} 変換後のテキスト */ static fromUTF16Array(utf16: number[]): string; /** * 文字列をUTF8の配列に変換 * @param {String} text - 変換したいテキスト * @returns {Array} UTF8のデータが入った配列 */ static toUTF8Array(text: string): number[]; /** * UTF8の配列から文字列に変換 * @param {Array} utf8 - 変換したいテキスト * @returns {String} 変換後のテキスト */ static fromUTF8Array(utf8: number[]): string; /** * 結合した文字を考慮して文字列を文字の配列に変換する * @param {String} text - 変換したいテキスト * @returns {Array>} UTF32(コードポイント)の配列が入った配列 */ static toMojiArrayFromString(text: string): number[][]; /** * 結合した文字を考慮して文字の配列を文字列に変換する * @param {Array>} mojiarray - UTF32(コードポイント)の配列が入った配列 * @returns {string} UTF32(コードポイント)の配列が入った配列 */ static toStringFromMojiArray(mojiarray: number[][]): string; /** * 指定したテキストを切り出す * - 単位はコードポイントの文字数 * - 結合文字, 異体字セレクタ, スキントーン修飾子, タグ文字を考慮しません * @param {String} text - 切り出したいテキスト * @param {Number} offset - 切り出し位置 * @param {Number} size - 切り出す長さ * @returns {String} 切り出したテキスト */ static cutTextForCodePoint(text: string, offset: number, size: number): string; /** * 指定したテキストの横幅を半角／全角でカウント * - 0幅 ... 結合文字, 異体字セレクタ, スキントーン修飾子, タグ文字, ゼロ幅スペース, ゼロ幅非接合子, ゼロ幅接合子, 単語結合子 * - 1幅 ... ASCII文字, 半角カタカナ * - 2幅 ... 上記以外 * @param {String} text - カウントしたいテキスト * @returns {Number} 文字の横幅 */ static getWidth(text: string): number; /** * 指定したテキストを切り出す * - 0幅 ... 結合文字, 異体字セレクタ, スキントーン修飾子, タグ文字, ゼロ幅スペース, ゼロ幅非接合子, ゼロ幅接合子, 単語結合子 * - 1幅 ... ASCII文字, 半角カタカナ * - 2幅 ... 上記以外 * @param {String} text - 切り出したいテキスト * @param {Number} offset - 切り出し位置 * @param {Number} size - 切り出す長さ * @returns {String} 切り出したテキスト */ static cutTextForWidth(text: string, offset: number, size: number): string; /** * 指定した文字から Windows-31J 上の区点番号に変換 * - 2文字以上を指定した場合は、1文字目のみを変換する * @param {String} text - 変換したいテキスト * @returns {_MenKuTen_} 区点番号(存在しない場合（1バイトのJISコードなど）はnullを返す) */ static toKuTen(text: string): _MenKuTen_; /** * Windows-31J 上の区点番号から文字列に変換 * @param {_MenKuTen_|string} kuten - 区点番号 * @returns {String} 変換後のテキスト */ static fromKuTen(kuten: any): string; /** * 指定した文字から Shift_JIS-2004 上の面区点番号に変換 * - 2文字以上を指定した場合は、1文字目のみを変換する * @param {String} text - 変換したいテキスト * @returns {_MenKuTen_} 面区点番号(存在しない場合（1バイトのJISコードなど）はnullを返す) */ static toMenKuTen(text: string): _MenKuTen_; /** * Shift_JIS-2004 上の面区点番号から文字列に変換 * @param {_MenKuTen_|string} menkuten - 面区点番号 * @returns {String} 変換後のテキスト */ static fromMenKuTen(menkuten: any): string; /** * カタカナをひらがなに変換 * @param {String} text - 変換したいテキスト * @returns {String} 変換後のテキスト */ static toHiragana(text: string): string; /** * ひらがなをカタカナに変換 * @param {String} text - 変換したいテキスト * @returns {String} 変換後のテキスト */ static toKatakana(text: string): string; /** * スペースを半角に変換 * @param {String} text - 変換したいテキスト * @returns {String} 変換後のテキスト */ static toHalfWidthSpace(text: string): string; /** * スペースを全角に変換 * @param {String} text - 変換したいテキスト * @returns {String} 変換後のテキスト */ static toFullWidthSpace(text: string): string; /** * 英数記号を半角に変換 * @param {String} text - 変換したいテキスト * @returns {String} 変換後のテキスト */ static toHalfWidthAsciiCode(text: string): string; /** * 英数記号を全角に変換 * @param {String} text - 変換したいテキスト * @returns {String} 変換後のテキスト */ static toFullWidthAsciiCode(text: string): string; /** * アルファベットを半角に変換 * @param {String} text - 変換したいテキスト * @returns {String} 変換後のテキスト */ static toHalfWidthAlphabet(text: string): string; /** * アルファベットを全角に変換 * @param {String} text - 変換したいテキスト * @returns {String} 変換後のテキスト */ static toFullWidthAlphabet(text: string): string; /** * 数値を半角に変換 * @param {String} text - 変換したいテキスト * @returns {String} 変換後のテキスト */ static toHalfWidthNumber(text: string): string; /** * 数値を全角に変換 * @param {String} text - 変換したいテキスト * @returns {String} 変換後のテキスト */ static toFullWidthNumber(text: string): string; /** * カタカナを半角に変換 * @param {String} text - 変換したいテキスト * @returns {String} 変換後のテキスト */ static toHalfWidthKana(text: string): string; /** * カタカナを全角に変換 * @param {String} text - 変換したいテキスト * @returns {String} 変換後のテキスト */ static toFullWidthKana(text: string): string; /** * 半角に変換 * @param {String} text - 変換したいテキスト * @returns {String} 変換後のテキスト */ static toHalfWidth(text: string): string; /** * 全角に変換 * @param {String} text - 変換したいテキスト * @returns {String} 変換後のテキスト */ static toFullWidth(text: string): string; /** * ローマ字からひらがなに変換 * @param {String} text - 変換したいテキスト * @returns {String} 変換後のテキスト */ static toHiraganaFromRomaji(text: string): string; /** * ローマ字からカタカナに変換 * @param {String} text - 変換したいテキスト * @returns {String} 変換後のテキスト */ static toKatakanaFromRomaji(text: string): string; /** * ひらがなからローマ字に変換 * @param {String} text - 変換したいテキスト * @returns {String} 変換後のテキスト */ static toRomajiFromHiragana(text: string): string; /** * カタカナからローマ字に変換 * @param {String} text - 変換したいテキスト * @returns {String} 変換後のテキスト */ static toRomajiFromKatakana(text: string): string; /** * 指定した1つのUTF-32 コードポイントに関して、解析を行い情報を返します * @param {Number} unicode_codepoint - UTF-32 のコードポイント * @returns {_MojiData_} 文字の情報がつまったオブジェクト */ static getMojiData(unicode_codepoint: number): _MojiData_; /** * 2つの文字列を比較する関数 * - sortの引数で利用できます * * @param {any} a - 比較元 * @param {any} b - 比較先 * @returns {number} Compare結果 */ static compareToForDefault(a: any, b: any): number; /** * 2つの文字列を自然順ソートで比較する関数 * - sortの引数で利用できます * - 入力引数は文字列化して比較します * * @param {any} a - 比較元 * @param {any} b - 比較先 * @returns {number} Compare結果 */ static compareToForNatural(a: any, b: any): number; } /** * 文字のエンコード情報 * @typedef {Object} _MojiEncodeData_ * @property {_MenKuTen_} kuten 区点 コード * @property {_MenKuTen_} menkuten 面区点 コード * @property {number} cp932_code _CP932_(Windows-31J) コード * @property {number} sjis2004_code Shift_JIS-2004 コード * @property {Array} utf8_array UTF-8 配列 * @property {Array} utf16_array UTF-16 配列 * @property {Array} utf32_array UTF-32 配列 * @property {Array} cp932_array _CP932_(Windows-31J) バイト配列 * @property {Array} sjis2004_array Shift_JIS-2004 コード バイト配列 * @property {Array} shift_jis_array Shift_JIS バイト配列 * @property {Array} iso2022jp_array ISO-2022-JP バイト配列 * @property {Array} eucjpms_array eucJP-ms バイト配列 * @property {Array} eucjis2004_array EUC-JP-2004 バイト配列 */ declare type _MojiEncodeData_ = { cp932_code: number; sjis2004_code: number; utf8_array: number[]; utf16_array: number[]; utf32_array: number[]; cp932_array: number[]; sjis2004_array: number[]; shift_jis_array: number[]; iso2022jp_array: number[]; eucjpms_array: number[]; eucjis2004_array: number[]; }; /** * 文字の種別情報 * @typedef {Object} _MojiTypeData_ * @property {boolean} is_regular_sjis Shift_JIS に登録された文字 * @property {boolean} is_regular_sjis2004 Shift_JIS-2004 に登録された文字 * @property {boolean} is_joyo_kanji 常用漢字 * @property {boolean} is_jinmeiyo_kanji 人名用漢字 * @property {boolean} is_gaiji_cp932 Windows-31J(_CP932_) 外字 * @property {boolean} is_IBM_extended_character Windows-31J(_CP932_) IBM拡張文字 * @property {boolean} is_NEC_selection_IBM_extended_character Windows-31J(_CP932_) NEC選定IBM拡張文字 * @property {boolean} is_NEC_special_character Windows-31J(_CP932_) NEC特殊文字 * @property {number} kanji_suijun Shift_JIS-2004 を使用して漢字の水準調査(1未満だと水準調査失敗) * @property {boolean} is_surrogate_pair 要 _Unicode_ サロゲートペア * @property {string} control_name 制御文字名（制御文字ではない場合は null） * @property {boolean} is_control_charcter 制御文字 * @property {string} blockname _Unicode_ブロック名 * @property {boolean} is_kanji 漢字 * @property {boolean} is_hiragana ひらがな * @property {boolean} is_katakana カタカナ * @property {boolean} is_fullwidth_ascii 全角ASCII * @property {boolean} is_halfwidth_katakana 半角カタカナ * @property {boolean} is_emoji 絵文字 * @property {boolean} is_emoticons 顔文字 * @property {boolean} is_symbol_base 記号(VS16 が付くと絵文字化) * @property {boolean} is_gaiji 外字 * @property {boolean} is_grapheme_component グラフェムを構成するための文字 * @property {boolean} is_zero_width_character ゼロ幅文字 * @property {boolean} is_combining_mark 結合文字 * @property {boolean} is_variation_selector 異体字セレクタ * @property {boolean} is_skin_tone_modifier スキントーン修飾子 * @property {boolean} is_tag_character タグ文字 */ declare type _MojiTypeData_ = { is_regular_sjis: boolean; is_regular_sjis2004: boolean; is_joyo_kanji: boolean; is_jinmeiyo_kanji: boolean; is_gaiji_cp932: boolean; is_IBM_extended_character: boolean; is_NEC_selection_IBM_extended_character: boolean; is_NEC_special_character: boolean; kanji_suijun: number; is_surrogate_pair: boolean; control_name: string; is_control_charcter: boolean; blockname: string; is_kanji: boolean; is_hiragana: boolean; is_katakana: boolean; is_fullwidth_ascii: boolean; is_halfwidth_katakana: boolean; is_emoji: boolean; is_emoticons: boolean; is_symbol_base: boolean; is_gaiji: boolean; is_grapheme_component: boolean; is_zero_width_character: boolean; is_combining_mark: boolean; is_variation_selector: boolean; is_skin_tone_modifier: boolean; is_tag_character: boolean; }; /** * 文字の種別情報 * @typedef {Object} _MojiData_ * @property {_MojiEncodeData_} encode 文字のエンコード情報 * @property {_MojiTypeData_} type 文字の種別情報 * @property {string} character 解析した文字 * @property {number} codepoint 解析した文字のコードポイント */ declare type _MojiData_ = { encode: _MojiEncodeData_; type: _MojiTypeData_; character: string; codepoint: number; };