summaryrefslogtreecommitdiffstats
path: root/intl/icu_capi/js/package/lib/ICU4XLocaleDirectionality.d.ts
blob: d8eb4ef0bf0821e116d5fec08fe4850ebe055fed (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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
import { FFIError } from "./diplomat-runtime"
import { ICU4XDataProvider } from "./ICU4XDataProvider";
import { ICU4XError } from "./ICU4XError";
import { ICU4XLocale } from "./ICU4XLocale";
import { ICU4XLocaleDirection } from "./ICU4XLocaleDirection";
import { ICU4XLocaleExpander } from "./ICU4XLocaleExpander";

/**

 * See the {@link https://docs.rs/icu/latest/icu/locid_transform/struct.LocaleDirectionality.html Rust documentation for `LocaleDirectionality`} for more information.
 */
export class ICU4XLocaleDirectionality {

  /**

   * Construct a new ICU4XLocaleDirectionality instance

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

  /**

   * Construct a new ICU4XLocaleDirectionality instance with a custom expander

   * See the {@link https://docs.rs/icu/latest/icu/locid_transform/struct.LocaleDirectionality.html#method.new_with_expander Rust documentation for `new_with_expander`} for more information.
   * @throws {@link FFIError}<{@link ICU4XError}>
   */
  static create_with_expander(provider: ICU4XDataProvider, expander: ICU4XLocaleExpander): ICU4XLocaleDirectionality | never;

  /**

   * See the {@link https://docs.rs/icu/latest/icu/locid_transform/struct.LocaleDirectionality.html#method.get Rust documentation for `get`} for more information.
   */
  get(locale: ICU4XLocale): ICU4XLocaleDirection;

  /**

   * See the {@link https://docs.rs/icu/latest/icu/locid_transform/struct.LocaleDirectionality.html#method.is_left_to_right Rust documentation for `is_left_to_right`} for more information.
   */
  is_left_to_right(locale: ICU4XLocale): boolean;

  /**

   * See the {@link https://docs.rs/icu/latest/icu/locid_transform/struct.LocaleDirectionality.html#method.is_right_to_left Rust documentation for `is_right_to_left`} for more information.
   */
  is_right_to_left(locale: ICU4XLocale): boolean;
}