diff options
Diffstat (limited to 'intl/icu_capi/js/package/lib/ICU4XGregorianZonedDateTimeFormatter.d.ts')
-rw-r--r-- | intl/icu_capi/js/package/lib/ICU4XGregorianZonedDateTimeFormatter.d.ts | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/intl/icu_capi/js/package/lib/ICU4XGregorianZonedDateTimeFormatter.d.ts b/intl/icu_capi/js/package/lib/ICU4XGregorianZonedDateTimeFormatter.d.ts new file mode 100644 index 0000000000..1b90d361a9 --- /dev/null +++ b/intl/icu_capi/js/package/lib/ICU4XGregorianZonedDateTimeFormatter.d.ts @@ -0,0 +1,49 @@ +import { FFIError } from "./diplomat-runtime" +import { ICU4XCustomTimeZone } from "./ICU4XCustomTimeZone"; +import { ICU4XDataProvider } from "./ICU4XDataProvider"; +import { ICU4XDateLength } from "./ICU4XDateLength"; +import { ICU4XError } from "./ICU4XError"; +import { ICU4XIsoDateTime } from "./ICU4XIsoDateTime"; +import { ICU4XIsoTimeZoneOptions } from "./ICU4XIsoTimeZoneOptions"; +import { ICU4XLocale } from "./ICU4XLocale"; +import { ICU4XTimeLength } from "./ICU4XTimeLength"; + +/** + + * An object capable of formatting a date time with time zone to a string. + + * See the {@link https://docs.rs/icu/latest/icu/datetime/struct.TypedZonedDateTimeFormatter.html Rust documentation for `TypedZonedDateTimeFormatter`} for more information. + */ +export class ICU4XGregorianZonedDateTimeFormatter { + + /** + + * Creates a new {@link ICU4XGregorianZonedDateTimeFormatter `ICU4XGregorianZonedDateTimeFormatter`} from locale data. + + * This function has `date_length` and `time_length` arguments and uses default options for the time zone. + + * See the {@link https://docs.rs/icu/latest/icu/datetime/struct.TypedZonedDateTimeFormatter.html#method.try_new Rust documentation for `try_new`} for more information. + * @throws {@link FFIError}<{@link ICU4XError}> + */ + static create_with_lengths(provider: ICU4XDataProvider, locale: ICU4XLocale, date_length: ICU4XDateLength, time_length: ICU4XTimeLength): ICU4XGregorianZonedDateTimeFormatter | never; + + /** + + * Creates a new {@link ICU4XGregorianZonedDateTimeFormatter `ICU4XGregorianZonedDateTimeFormatter`} from locale data. + + * This function has `date_length` and `time_length` arguments and uses an ISO-8601 style fallback for the time zone with the given configurations. + + * See the {@link https://docs.rs/icu/latest/icu/datetime/struct.TypedZonedDateTimeFormatter.html#method.try_new Rust documentation for `try_new`} for more information. + * @throws {@link FFIError}<{@link ICU4XError}> + */ + static create_with_lengths_and_iso_8601_time_zone_fallback(provider: ICU4XDataProvider, locale: ICU4XLocale, date_length: ICU4XDateLength, time_length: ICU4XTimeLength, zone_options: ICU4XIsoTimeZoneOptions): ICU4XGregorianZonedDateTimeFormatter | never; + + /** + + * Formats a {@link ICU4XIsoDateTime `ICU4XIsoDateTime`} and {@link ICU4XCustomTimeZone `ICU4XCustomTimeZone`} to a string. + + * See the {@link https://docs.rs/icu/latest/icu/datetime/struct.TypedZonedDateTimeFormatter.html#method.format Rust documentation for `format`} for more information. + * @throws {@link FFIError}<{@link ICU4XError}> + */ + format_iso_datetime_with_custom_time_zone(datetime: ICU4XIsoDateTime, time_zone: ICU4XCustomTimeZone): string | never; +} |