summaryrefslogtreecommitdiffstats
path: root/intl/icu_capi/js/package/lib/ICU4XCanonicalDecomposition.d.ts
blob: debadba0aba8d332605ec620e1d82453ba90d72f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
import { char } from "./diplomat-runtime"
import { FFIError } from "./diplomat-runtime"
import { ICU4XDataProvider } from "./ICU4XDataProvider";
import { ICU4XDecomposed } from "./ICU4XDecomposed";
import { ICU4XError } from "./ICU4XError";

/**

 * The raw (non-recursive) canonical decomposition operation.

 * Callers should generally use ICU4XDecomposingNormalizer unless they specifically need raw composition operations

 * See the {@link https://docs.rs/icu/latest/icu/normalizer/properties/struct.CanonicalDecomposition.html Rust documentation for `CanonicalDecomposition`} for more information.
 */
export class ICU4XCanonicalDecomposition {

  /**

   * Construct a new ICU4XCanonicalDecomposition instance for NFC

   * See the {@link https://docs.rs/icu/latest/icu/normalizer/properties/struct.CanonicalDecomposition.html#method.new Rust documentation for `new`} for more information.
   * @throws {@link FFIError}<{@link ICU4XError}>
   */
  static create(provider: ICU4XDataProvider): ICU4XCanonicalDecomposition | never;

  /**

   * Performs non-recursive canonical decomposition (including for Hangul).

   * See the {@link https://docs.rs/icu/latest/icu/normalizer/properties/struct.CanonicalDecomposition.html#method.decompose Rust documentation for `decompose`} for more information.
   */
  decompose(c: char): ICU4XDecomposed;
}