59 lines
3 KiB
TypeScript
59 lines
3 KiB
TypeScript
import { FFIError } from "./diplomat-runtime"
|
|
import { ICU4XCustomTimeZone } from "./ICU4XCustomTimeZone";
|
|
import { ICU4XDataProvider } from "./ICU4XDataProvider";
|
|
import { ICU4XDateLength } from "./ICU4XDateLength";
|
|
import { ICU4XDateTime } from "./ICU4XDateTime";
|
|
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.ZonedDateTimeFormatter.html Rust documentation for `ZonedDateTimeFormatter`} for more information.
|
|
*/
|
|
export class ICU4XZonedDateTimeFormatter {
|
|
|
|
/**
|
|
|
|
* Creates a new {@link ICU4XZonedDateTimeFormatter `ICU4XZonedDateTimeFormatter`} 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.ZonedDateTimeFormatter.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): ICU4XZonedDateTimeFormatter | never;
|
|
|
|
/**
|
|
|
|
* Creates a new {@link ICU4XZonedDateTimeFormatter `ICU4XZonedDateTimeFormatter`} 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.ZonedDateTimeFormatter.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): ICU4XZonedDateTimeFormatter | never;
|
|
|
|
/**
|
|
|
|
* Formats a {@link ICU4XDateTime `ICU4XDateTime`} and {@link ICU4XCustomTimeZone `ICU4XCustomTimeZone`} to a string.
|
|
|
|
* See the {@link https://docs.rs/icu/latest/icu/datetime/struct.ZonedDateTimeFormatter.html#method.format Rust documentation for `format`} for more information.
|
|
* @throws {@link FFIError}<{@link ICU4XError}>
|
|
*/
|
|
format_datetime_with_custom_time_zone(datetime: ICU4XDateTime, time_zone: ICU4XCustomTimeZone): string | never;
|
|
|
|
/**
|
|
|
|
* Formats a {@link ICU4XIsoDateTime `ICU4XIsoDateTime`} and {@link ICU4XCustomTimeZone `ICU4XCustomTimeZone`} to a string.
|
|
|
|
* See the {@link https://docs.rs/icu/latest/icu/datetime/struct.ZonedDateTimeFormatter.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;
|
|
}
|