@mathrunet/masamune/dist/lib/exntensions/string.extension.d.ts

Manages packages for the server portion (NodeJS) of the Masamune framework.

export {};
declare global {
    interface String {
        /**
         * Encrypts a string.
         * 文字列を暗号化します。
         *
         * @param {string} key
         * Encryption key #1. (32 bytes)
         * 暗号化キー1。(32バイト)
         *
         * @param {string} ivKey
         * Encryption key 2. (16 bytes)
         * 暗号化キー2。(16バイト)
         *
         * @return {string}
         * Encrypted string.
         * 暗号化された文字列。
         */
        encrypt({ key, ivKey }: {
            key: string;
            ivKey: string;
        }): string;
        /**
         * Decrypts a string.
         * 文字列を復号化します。
         *
         * @param {string} key
         * Encryption key #1. (32 bytes)
         * 暗号化キー1。(32バイト)
         * @param {string} ivKey
         * Encryption key 2. (16 bytes)
         * 暗号化キー2。(16バイト)
         *
         * @return {string}
         * Decrypted string.
         * 復号化された文字列。
         */
        decrypt({ key, ivKey, }: {
            key: string;
            ivKey: string;
        }): string;
        /**
         * Converts alphabets and numbers to full-width characters.
         *
         * アルファベットと数字を全角に変換します。
         *
         * ```typescript
         * const text = "abcd";
         * const converted = text.toZenkakuNumericAndAlphabet(); // "ａｂｃｄ"
         * ```
         *
         * @return {string}
         * Full-width string.
         * 全角に変換された文字列。
         */
        toZenkakuNumericAndAlphabet(): string;
        /**
         * Converts alphabets and numbers to half-width characters.
         *
         * アルファベットと数字を半角に変換します。
         *
         * ```typescript
         * const text = "ａｂｃｄ";
         * const converted = text.toHankakuNumericAndAlphabet(); // "abcd"
         * ```
         *
         * @return {string}
         * Half-width string.
         * 半角に変換された文字列。
         */
        toHankakuNumericAndAlphabet(): string;
        /**
         * Converts katakana to hiragana.
         *
         * カタカナをひらがなに変換します。
         *
         * ```typescript
         * const text = "アイウエオ";
         * const converted = text.toHiragana(); // "あいうえお"
         * ```
         *
         * @return {string}
         * Hiragana string.
         * ひらがなに変換された文字列。
         */
        toHiragana(): string;
        /**
         * Converts hiragana into katakana.
         *
         * ひらがなをカタカナに変換します。
         *
         * ```typescript
         * const text = "あいうえお";
         * const converted = text.toKatakana(); // "アイウエオ"
         * ```
         *
         * @return {string}
         * Katakana string.
         * カタカナに変換された文字列。
         */
        toKatakana(): string;
        /**
         * Converts half-width katakana to full-width katakana.
         *
         * 半角カタカナを全角カタカナに変換します。
         *
         * ```typescript
         * const text = "ｱｲｳｴｵ";
         * const converted = text.toZenkakuKatakana(); // "アイウエオ"
         * ```
         *
         * @return {string}
         * Full-width katakana string.
         * 全角カタカナに変換された文字列。
         */
        toZenkakuKatakana(): string;
        /**
         * Converts [String] to an array of one character at a time.
         *
         * [String]を1文字ずつの配列に変換します。
         *
         * ```typescript
         * const text = "abcde";
         * const characters = text.splitByCharacter(); // ["a", "b", "c", "d", "e"];
         * ```
         *
         * @return {string[]}
         * Array of one character at a time.
         * 1文字ずつの配列。
         */
        splitByCharacter(): string[];
        /**
         * Convert [String] to Bigram, i.e., an array of two characters each.
         *
         * [String]をBigram、つまり2文字ずつの配列に変換します。
         *
         * ```typescript
         * const text = "abcde";
         * const characters = text.splitByBigram(); // ["ab", "bc", "cd", "de"];
         * ```
         *
         * @return {string[]}
         * Array of two characters at a time.
         * 2文字ずつの配列。
         */
        splitByBigram(): string[];
        /**
         * Converts [String] into a one-character array and a two-character array.
         *
         * [String]を1文字ずつの配列と2文字ずつの配列に変換します。
         *
         * ```typescript
         * const text = "abcde";
         * const characters = text.splitByCharacterAndBigram(); // ["a", "b", "c", "d", "e", "ab", "bc", "cd", "de"];
         * ```
         *
         * @return {string[]}
         * Array of one character at a time and two characters at a time.
         * 1文字ずつと2文字ずつの配列。
         */
        splitByCharacterAndBigram(): string[];
        /**
         * Convert [String] to Trigram, i.e., an array of 3 characters each.
         *
         * [String]をTrigram、つまり3文字ずつの配列に変換します。
         *
         * ```typescript
         * const text = "abcde";
         * const characters = text.splitByTrigram(); // ["abc", "bcd", "cde"];
         * ```
         *
         * @return {string[]}
         * Array of three characters at a time.
         * 3文字ずつの配列。
         */
        splitByTrigram(): string[];
        /**
         * Removes only emojis from [String].
         *
         * [String]から絵文字のみを削除します。
         *
         * @return {string}
         * String without emojis.
         * 絵文字を削除した文字列。
         */
        removeOnlyEmoji(): string;
        /**
         * Converts [string] to a valid Firestore map key by removing invalid characters.
         *
         * FirestoreのMapのキーとして使用できるように、[string]から無効な文字を削除します。
         *
         * Invalid characters removed: . / ~ * [ ]
         * 削除される無効な文字: . / ~ * [ ]
         *
         * @return {string}
         * String that can be used as a Firestore map key.
         * FirestoreのMapのキーとして使用できる文字列。
         */
        toFirestoreMapKey(): string;
        /**
         * Converts [string] to a searchable map.
         *
         * [string]を検索可能なマップに変換します。
         *
         * @return {{ [key: string]: any }}
         * Searchable map.
         * 検索可能なマップ。
         */
        toSearchableMap(): {
            [key: string]: any;
        };
    }
}