@lazy-cjk/korean-romanize/lib/hangul/unicode/decompose.d.ts

String conversion utility to romanize Korean characters

import { IOptionsRomanize } from '../../types';
/**
 * Based on "Arithmetic Decomposition Mapping" as described in Unicode core spec for "LV" Hangul syllable types
 *
 * @param {(string|integer)} s
 * @returns {array}
 */
export declare function arithmeticDecompositionMappingLV(s: string | number): [number, number];
/**
 * Based on "Arithmetic Decomposition Mapping" as described in Unicode core spec for "LVT" Hangul syllable types
 *
 * @param {(string|integer)} s
 * @returns {array}
 */
export declare function arithmeticDecompositionMappingLVT(s: string | number): [number, number];
/**
 * Derives a canonical decomposition of a precomposed/composite Hangul syllable
 *
 * Based on "Full Canonical Decomposition" as described in Unicode core
 * specification for canonical decomposition mappings.
 *
 * In other words:
 *
 * This function computes the code points for the Hangul letters (jamo) derived
 * algorithmically for a given Hangul syllable's code point.
 *
 * The algorithm is described in the core spec (v. 12.1, Chapter 3), under section
 * "3.12 Conjoining Jamo Behavior" (pp. 142-151).
 *
 * @param {(string|integer)} s
 * @returns {array}
 */
export declare function decomposeHangulChar(s: string | number): number[];
/**
 * Returns a mapping of each Hangul character provided to an array of code points for the decomposed letters (jamo)
 *
 * @param {string} word
 * @returns {array}
 */
export declare function decomposeHangul(word: string, options?: IOptionsRomanize): (string[] | number[])[];