@vertigis/arcgis-extensions 47.1.0 → 47.2.1

package/utilities/format/date.d.ts

@@ -0,0 +1,336 @@
+import type { PropertyDefs } from "../../support/Serializable.js";
+import { SerializableBase } from "../../support/Serializable.js";
+/**
+ * Creates an error message for an invalid time zone.
+ *
+ * @param timeZone The invalid time zone string.
+ */
+export declare const ERR_TIME_ZONE_INVALID: (timeZone: string) => string;
+/**
+ * The default set of formats used for parsing date values.
+ */
+export declare const DEFAULT_PARSING_FORMATS: string[];
+/**
+ * Default settings that affect how dates are formatted and parsed.
+ */
+export interface DateSettings {
+    /**
+     * The default format for formatting dates. See
+     * {@link utilities/format/date!DateFormatter.format}.
+     */
+    defaultFormat?: string;
+    /**
+     * Either a single format, or one of several possible formats that the input
+     * is expected to be in. If specified, the input must _exactly_ match. The
+     * syntax is the same as for
+     * {@link utilities/format/date!DateFormatter.format}.
+     */
+    defaultParseFormat?: string | string[];
+}
+/**
+ * Options supported by {@link format}.
+ */
+export interface FormatOptions {
+    /**
+     * The locale to use when formatting the date. If not specified, the current
+     * locale is used (see locale module).
+     */
+    locale?: string;
+    /**
+     * The date format. See {@link utilities/format/date!DateFormatter.format}.
+     */
+    format?: string;
+    /**
+     * The time zone of the date being formatted.
+     */
+    timeZone?: string;
+    /**
+     * Indicates if the date should be formatted without the time component even
+     * if the format suggests to include a time.
+     */
+    isDateOnly?: boolean;
+}
+/**
+ * Options supported by {@link parse}.
+ */
+export interface ParseOptions {
+    /**
+     * The locale to use when parsing the date. If not specified, the current
+     * locale is used (see locale module).
+     */
+    locale?: string;
+    /**
+     * Either a single format, or one of several possible formats that the input
+     * is expected to be in. If specified, the input must _exactly_ match. See
+     * {@link utilities/format/date!DateFormatter.format}.
+     */
+    format?: string | string[];
+    /**
+     * The time zone of the date being parsed.
+     */
+    timeZone?: string;
+    /**
+     * Indicates if the date should be parsed without expecting the time
+     * component even if the format suggests there is a time.
+     */
+    isDateOnly?: boolean;
+}
+/**
+ * A special date instance that signifies failure to parse a date. This way of
+ * signifying failure is in keeping with "new Date(string)" and
+ * "Date.parse(string)".
+ */
+export declare const INVALID_DATE: Date;
+/**
+ * Determines whether the given date object represents a valid date.
+ *
+ * @param date The date to check.
+ */
+export declare function isValid(date: Date): boolean;
+/**
+ * Formats a date for display in the current locale.
+ *
+ * @param date The date to format.
+ */
+export declare function format(date: Date): string;
+/**
+ * Formats a date for display.
+ *
+ * @param format See {@link utilities/format/date!DateFormatter.format}.
+ * @param date The date to format.
+ */
+export declare function format(format: string, date: Date): string;
+/**
+ * Formats a date for display.
+ *
+ * @param options Specifies the format settings to use.
+ * @param date The date to format.
+ */
+export declare function format(options: FormatOptions, date: Date): string;
+/**
+ * Parses a value into a Date object. The input is assumed to be in local time.
+ *
+ * @param input The input to parse. Numbers are treated as UNIX timestamps
+ *   (always UTC).
+ * @returns A Date object corresponding to the input, which might be an Invalid
+ *   Date (i.e. getTime() will be NaN).
+ */
+export declare function parse(input: unknown): Date;
+/**
+ * Parses a value into a Date object. The input is assumed to be in local time.
+ *
+ * @param format See {@link ParseOptions.format}.
+ * @param input The input to parse. Numbers are treated as UNIX timestamps
+ *   (always UTC).
+ * @returns A Date object corresponding to the input, which might be an Invalid
+ *   Date (i.e. getTime() will be NaN).
+ */
+export declare function parse(format: string | string[], input: unknown): Date;
+/**
+ * Parses a value into a Date object. The input is assumed to be in local time.
+ *
+ * @param options The options to use for parsing.
+ * @param input The input to parse. Numbers are treated as UNIX timestamps
+ *   (always UTC).
+ * @returns A Date object corresponding to the input, which might be an Invalid
+ *   Date (i.e. getTime() will be NaN).
+ */
+export declare function parse(options: ParseOptions, input: unknown): Date;
+/**
+ * Parses a value into a Date object. The input is assumed to be in UTC.
+ *
+ * @param input The input to parse. Numbers are treated as UNIX timestamps.
+ * @returns A Date object corresponding to the input, which might be an Invalid
+ *   Date (i.e. getTime() will be NaN).
+ */
+export declare function parseUtc(input: unknown): Date;
+/**
+ * Parses a value into a Date object. The input is assumed to be in UTC.
+ *
+ * @param format See {@link ParseOptions.format}.
+ * @param input The input to parse. Numbers are treated as UNIX timestamps.
+ * @returns A Date object corresponding to the input, which might be an Invalid
+ *   Date (i.e. getTime() will be NaN).
+ */
+export declare function parseUtc(format: string | string[], input: unknown): Date;
+/**
+ * Parses a value into a Date object. The input is assumed to be in UTC.
+ *
+ * @param options The options to use for parsing.
+ * @param input The input to parse. Numbers are treated as UNIX timestamps.
+ * @returns A Date object corresponding to the input, which might be an Invalid
+ *   Date (i.e. getTime() will be NaN).
+ */
+export declare function parseUtc(options: ParseOptions, input: unknown): Date;
+/**
+ * Converts an Esri-style date format constant (e.g. "short-date-short-time") to
+ * a format string that can be used with {@link format} and {@link parse}.
+ *
+ * @param format The Esri-style format constant to convert.
+ */
+export declare function esriFormatToGeocortexFormat(format: string): string;
+/**
+ * Checks that a given time zone is valid.
+ *
+ * @param timeZone The IANA tz database identifier of the target time zone, e.g.
+ *   "America/Vancouver", "Pacific/Fiji". See http://www.iana.org/time-zones and
+ *   {@link https://en.wikipedia.org/wiki/List_of_tz_database_time_zones}.
+ * @returns True if the time zone is valid and false if not.
+ */
+export declare function isValidTimeZone(timeZone: string): boolean;
+/**
+ * Properties that can be passed into the constructor for
+ * {@link utilities/format/date!DateFormatter}.
+ */
+export interface DateFormatterProperties extends DateSettings {
+    /**
+     * The locale to use when formatting & parsing the number. If not specified,
+     * the current locale is used (see locale module).
+     */
+    locale?: string;
+    /**
+     * The time zone of the date being formatted.
+     */
+    timeZone?: string;
+    /**
+     * The time zone of the date being parsed.
+     */
+    parseTimeZone?: string;
+}
+/**
+ * A helper class for formatting and parsing dates.
+ */
+export declare class DateFormatter extends SerializableBase<DateFormatterProperties> implements DateSettings {
+    /**
+     * @inheritDoc
+     */
+    get defaultFormat(): string;
+    /**
+     * @inheritDoc
+     */
+    set defaultFormat(value: string);
+    /**
+     * @inheritDoc
+     */
+    defaultParseFormat: string;
+    /**
+     * The locale to use when formatting & parsing the number. If not specified,
+     * the current locale is used (see locale module).
+     */
+    locale: string;
+    /**
+     * The time zone of the date being formatted.
+     */
+    get timeZone(): string;
+    set timeZone(value: string);
+    /**
+     * The time zone of the date being parsed.
+     */
+    get parseTimeZone(): string;
+    set parseTimeZone(value: string);
+    private _timeZone;
+    private _parseTimeZone;
+    private _defaultFormat;
+    /**
+     * Formats a date for display.
+     *
+     * @param date The date to format.
+     */
+    format(date: Date): string;
+    /**
+     * Formats a date for display.
+     *
+     * @param date The date to format.
+     * @param format The format for presenting dates. One of the
+     *   {@link utilities/format/formats!DateFormat} constants, or a custom
+     *   format string. The format string syntax is similar to
+     *   {@link https://msdn.microsoft.com/en-us/library/8kb3ddd4.aspx|this},
+     *   with the following exceptions:
+     *
+     *   - "/", and ":" are treated as literal characters.
+     *   - "y" is treated as "yy", and "yyy" is treated as "yyyy".
+     *   - "z" and "zz" and "zzz" are treated as the UTC offset
+     *   - "t" is treated the same as "tt".
+     *   - "F", "FF", "FFF" etc. will behave the same as "f", "ff", "fff", etc.
+     *       Additionally, a maximum of 3 digits (milliseconds) is supported.
+     *       Longer formatters like "fffff" are truncated to 3 digits, rather
+     *       than padded with zeros.
+     *   - "K" is not supported at all and will be ignored. If not specified, it
+     *       will default to DATE_TIME_SHORT.
+     */
+    format(format: string, date: Date): string;
+    /**
+     * Formats a date for display.
+     *
+     * @param date The date to format.
+     * @param options Options that control how the date is formatted.
+     */
+    format(options: FormatOptions, date: Date): string;
+    /**
+     * Parses a value into a Date object. The input is assumed to be in local
+     * time, unless it's a timestamp..
+     *
+     * @param input The input to parse. Numbers are treated as UNIX timestamps
+     *   (always assumed to be UTC unless timezone is specified).
+     * @returns A Date object corresponding to the input, which might be an
+     *   Invalid Date (i.e. getTime() will be NaN).
+     */
+    parse(input: unknown): Date;
+    /**
+     * Parses a value into a Date object. The input is assumed to be in local
+     * time, unless it's a timestamp..
+     *
+     * @param input The input to parse. Numbers are treated as UNIX timestamps
+     *   (always assumed to be UTC unless timezone is specified).
+     * @param format See {@link ParseOptions.format}.
+     * @returns A Date object corresponding to the input, which might be an
+     *   Invalid Date (i.e. getTime() will be NaN).
+     */
+    parse(format: string | string[], input: unknown): Date;
+    /**
+     * Parses a value into a Date object. The input is assumed to be in local
+     * time, unless it's a timestamp.
+     *
+     * @param input The input to parse. Numbers are treated as UNIX timestamps
+     *   (always assumed to be UTC unless timezone is specified).
+     * @param options The options to use for parsing.
+     * @returns A Date object corresponding to the input, which might be an
+     *   Invalid Date (i.e. getTime() will be NaN).
+     */
+    parse(options: ParseOptions, input: unknown): Date;
+    /**
+     * Parses a value into a Date object. The input is assumed to be in UTC.
+     *
+     * @param input The input to parse. Numbers are treated as UNIX timestamps
+     *   (always assumed to be UTC even if timezone is specified).
+     * @returns A Date object corresponding to the input, which might be an
+     *   Invalid Date (i.e. getTime() will be NaN).
+     */
+    parseUtc(input: unknown | undefined): Date;
+    /**
+     * Parses a value into a Date object. The input is assumed to be in UTC.
+     *
+     * @param input The input to parse. Numbers are treated as UNIX timestamps
+     *   (always assumed to be UTC even if timezone is specified).
+     * @param format See {@link ParseOptions.format}.
+     * @returns A Date object corresponding to the input, which might be an
+     *   Invalid Date (i.e. getTime() will be NaN).
+     */
+    parseUtc(format: string | string[], input: unknown): Date;
+    /**
+     * Parses a value into a Date object. The input is assumed to be in UTC.
+     *
+     * @param input The input to parse. Numbers are treated as UNIX timestamps
+     *   (always assumed to be UTC even if timezone is specified).
+     * @param options The options to use for parsing.
+     * @returns A Date object corresponding to the input, which might be an
+     *   Invalid Date (i.e. getTime() will be NaN).
+     */
+    parseUtc(options: ParseOptions, input: unknown): Date;
+    protected _getSerializableProperties(): PropertyDefs<DateFormatterProperties>;
+    private _parse;
+}
+/**
+ * Default settings used for formatting and parsing dates.
+ */
+export declare const settings: DateSettings;

package/utilities/format/date.js

@@ -0,0 +1 @@
+import{__decorate as e}from"tslib";import{DateTime as t}from"luxon";import{get as r,INVARIANT as o}from"../../locale.js";import{serializable as n,SerializableBase as s}from"../../support/Serializable.js";import{checkArg as a}from"../checkArg.js";import{isNumeric as i}from"../number.js";import{settings as m}from"./FormatSettings.js";import{gcxDateTimeFormatToLuxonFormat as y}from"./_utils.js";import{DateFormat as d}from"./formats.js";import{parse as l}from"./number.js";export const ERR_TIME_ZONE_INVALID=e=>`Unrecognized time zone ${e}. Make sure it is a valid IANA time zone name, e.g. "America/Vancouver".`;export const DEFAULT_PARSING_FORMATS=[d.ISO_8601,d.DATE_TIME_SHORT,d.DATE_TIME_LONG,d.DATE_SHORT,d.DATE_LONG];export const INVALID_DATE=new Date(NaN);export function isValid(e){return e&&!isNaN(e.getTime())}export function format(...e){return h.format(...e)}export function parse(...e){return h.parse(...e)}export function parseUtc(...e){return h.parseUtc(...e)}export function esriFormatToGeocortexFormat(e){if(e)switch(e){case"short-date":return"d";case"short-date-short-time":return"εσρι M/d/yyyy h:mm tt";case"short-date-short-time-24":return"εσρι M/d/yyyy H:mm";case"short-date-long-time":return"εσρι M/d/yyyy h:mm:ss tt";case"short-date-long-time-24":return"εσρι M/d/yyyy H:mm:ss";case"short-date-le":return"d/M/yyyy";case"short-date-le-short-time":return"d/M/yyyy h:mm tt";case"short-date-le-short-time-24":return"d/M/yyyy H:mm";case"short-date-le-long-time":return"d/M/yyyy h:mm:ss tt";case"short-date-le-long-time-24":return"d/M/yyyy H:mm:ss";case"long-month-day-year":return"D";case"long-month-day-year-short-time":return"εσρι MMMM d yyyy h:mm tt";case"long-month-day-year-short-time-24":return"εσρι MMMM d yyyy H:mm";case"long-month-day-year-long-time":return"εσρι MMMM d yyyy h:mm:ss tt";case"long-month-day-year-long-time-24":return"εσρι MMMM d yyyy H:mm:ss";case"day-short-month-year":return"d MMM yyyy";case"day-short-month-year-short-time":return"d MMM yyyy h:mm tt";case"day-short-month-year-short-time-24":return"d MMM yyyy H:mm";case"day-short-month-year-long-time":return"d MMM yyyy h:mm:ss tt";case"day-short-month-year-long-time-24":return"d MMM yyyy H:mm:ss";case"long-date":return"dddd, MMMM d, yyyy";case"long-date-short-time":return"dddd, MMMM d, yyyy h:mm tt";case"long-date-short-time-24":return"dddd, MMMM d, yyyy H:mm";case"long-date-long-time":return"dddd, MMMM d, yyyy H:mm tt";case"long-date-long-time-24":return"dddd, MMMM d, yyyy H:mm:ss";case"long-month-year":return"MMMM yyyy";case"short-month-year":return"MMM yyyy";case"year":return"yyyy";default:throw new Error(`Unrecognized date format constant: ${e}`)}}function u(e,r){const o=t.fromMillis(e).setZone("UTC").toISO({includeOffset:!1});return t.fromISO(o,{zone:r}).valueOf()}export function isValidTimeZone(e){try{return new Intl.DateTimeFormat(void 0,{timeZone:e}),!0}catch{return!1}}let M=class extends s{get defaultFormat(){return this._defaultFormat}set defaultFormat(e){this._defaultFormat=e}defaultParseFormat;locale;get timeZone(){return this._timeZone}set timeZone(e){a("timezone",e).satisfies(isValidTimeZone,ERR_TIME_ZONE_INVALID(e)),this._timeZone=e}get parseTimeZone(){return this._parseTimeZone}set parseTimeZone(e){a("timezone",e).satisfies(isValidTimeZone,ERR_TIME_ZONE_INVALID(e)),this._parseTimeZone=e}_timeZone;_parseTimeZone;_defaultFormat;format(...e){let n,s;if(1===arguments.length?(n=e[0],s={}):arguments.length>=2&&(n=e[1],s="string"==typeof e[0]?{format:e[0]}:e[0],a("options",s).isNotMissing()),!n)return"";if(s.timeZone&&a("timezone",s.timeZone).satisfies(isValidTimeZone,ERR_TIME_ZONE_INVALID(s.timeZone)),!n?.getTime||isNaN(n.getTime()))return"";const i=s.timeZone??this.timeZone;let m=s.locale??this.locale??r();m===o&&(m="en");const l=s.format??this.defaultFormat??d.DEFAULT,u=y(l,s.isDateOnly);let M=t.fromJSDate(n).setLocale(m);return i&&(M=M.setZone(i)),"ISO-8601"===u?M.toISO():M.toFormat(u)}parse(...e){return this._parse(!1,...e)}parseUtc(...e){return this._parse(!0,...e)}_getSerializableProperties(){return{defaultFormat:"initial",defaultParseFormat:"initial",locale:"initial",timeZone:"initial",parseTimeZone:"initial"}}_parse(e,...o){let n,s;if(1===o.length?(n=o[0],s={}):o.length>=2&&(n=o[1],s="string"==typeof o[0]||Array.isArray(o[0])?{format:o[0]}:o[0]),s.timeZone&&a("timezone",s.timeZone).satisfies(isValidTimeZone,ERR_TIME_ZONE_INVALID(s.timeZone)),n instanceof Date)return n;if("number"==typeof n){const t=s.timeZone&&!e?u(n,s.timeZone):n;return new Date(t)}if("string"!=typeof n)return INVALID_DATE;let{format:m}=s;if(void 0===m&&i(n)){let t=l(n);return t=s.timeZone&&!e?u(t,s.timeZone):t,new Date(t)}m=m??this.defaultParseFormat??DEFAULT_PARSING_FORMATS;const d=[].concat(m),M=s.timeZone??this.parseTimeZone,c={locale:s.locale??this.locale??r(),zone:e?"UTC":M,setZone:!0};for(const e of d){const r=y(e,s.isDateOnly),o="ISO-8601"===r?t.fromISO(n,c):t.fromFormat(n,r,c);if(o.isValid)return o.toJSDate()}return INVALID_DATE}};M=e([n],M);export{M as DateFormatter};let c=class extends M{get defaultFormat(){return m.dateFormat}set defaultFormat(e){m.dateFormat=e}get timeZone(){return m.timeZone}set timeZone(e){m.timeZone=e}};c=e([n],c);const h=new c;export const settings=h;

package/utilities/format/formats.d.ts

@@ -0,0 +1,127 @@
+/**
+ * Pre-defined format specifiers for use with
+ * {@link utilities/format/date!format}.
+ */
+export declare enum DateFormat {
+    /**
+     * A localized representation of a date (e.g. "09/04/1986" for en-US
+     * locale).
+     */
+    DATE_SHORT = "d",
+    /**
+     * A localized long representation of a date (e.g. "September 4 1986" for
+     * en-US locale).
+     */
+    DATE_LONG = "D",
+    /**
+     * A localized short representation of the time (e.g. "8:30 PM" for en-US
+     * locale).
+     */
+    TIME_SHORT = "t",
+    /**
+     * A localized representation of the time including seconds (e.g. "8:30:25
+     * PM" for en-US locale).
+     */
+    TIME_LONG = "T",
+    /**
+     * A localized representation of date and time (e.g. "Sep 4 1986 8:30 PM"
+     * for en-US locale).
+     */
+    DATE_TIME_SHORT = "g",
+    /**
+     * A localized long representation of date and time (e.g. "September 4 1986
+     * 8:30 PM" for en-US locale).
+     */
+    DATE_TIME_LONG = "G",
+    /**
+     * A localized full representation of date and time, including day of week
+     * (e.g. "Thursday, September 4 1986 8:30 PM" for en-US locale).
+     */
+    FULL = "f",
+    /**
+     * The date and time in ISO-8601 format (e.g. "2014-09-08T08:02:17-05:00").
+     * Invariant.
+     */
+    ISO_8601 = "u",
+    /**
+     * An invariant representation of a date. Guarantees that the date can be
+     * parsed back into the same date, regardless of locale. Equivalent to
+     * ISO-8601.
+     */
+    ROUND_TRIP = "u",
+    /**
+     * The default representation for date values (equivalent to
+     * DATE_TIME_SHORT).
+     */
+    DEFAULT = "g"
+}
+/**
+ * Pre-defined format specifiers for use with
+ * {@link utilities/format/number!format}.
+ */
+export declare enum NumberFormat {
+    /**
+     * A localized representation of a number with a decimal separator and group
+     * separators (e.g. "12,345.67", "-42" for en-US locale).
+     */
+    NUMBER = "n",
+    /**
+     * A localized representation of a number with a decimal separator (e.g.
+     * "12345.67", "-42" for en-US locale).
+     */
+    FIXED_POINT = "f",
+    /**
+     * A localized representation of a monetary amount in a specific currency
+     * (e.g. "$123.45" for USD, "£123.45" for GBP for en-US locale).
+     */
+    CURRENCY = "c",
+    /**
+     * Same as CURRENCY, except that negative values are displayed in
+     * parentheses instead of using a "-" sign.
+     */
+    ACCOUNTING = "a",
+    /**
+     * A localized representation of a percentage (e.g. 0.99 -> "99%" in the
+     * en-US locale).
+     */
+    PERCENT = "p",
+    /**
+     * An invariant representation of a number (e.g. "12345.67"). Guarantees
+     * that the number can be parsed back into the same number, regardless of
+     * locale.
+     */
+    ROUND_TRIP = "r",
+    /**
+     * The default representation for number values (equivalent to FIXED_POINT).
+     */
+    DEFAULT = "f"
+}
+/**
+ * Pre-defined format specifiers for use with
+ * {@link utilities/format/time!format}.
+ */
+export declare enum TimeFormat {
+    /**
+     * A localized short representation of the time (e.g. "8:30 PM" for en-US
+     * locale).
+     */
+    TIME_SHORT = "t",
+    /**
+     * A localized representation of the time including seconds (e.g. "8:30:25
+     * PM" for en-US locale).
+     */
+    TIME_LONG = "T",
+    /**
+     * The time in ISO-8601 format (e.g. "08:02:17"). Invariant.
+     */
+    ISO_8601 = "u",
+    /**
+     * An invariant representation of a time. Guarantees that the time can be
+     * parsed back into the same time. Equivalent to ISO-8601.
+     */
+    ROUND_TRIP = "u",
+    /**
+     * The default representation for time values (equivalent to TIME_SHORT).
+     */
+    DEFAULT = "t"
+}

package/utilities/format/formats.js

@@ -0,0 +1 @@
+export var DateFormat;!function(T){T.DATE_SHORT="d",T.DATE_LONG="D",T.TIME_SHORT="t",T.TIME_LONG="T",T.DATE_TIME_SHORT="g",T.DATE_TIME_LONG="G",T.FULL="f",T.ISO_8601="u",T.ROUND_TRIP="u",T.DEFAULT="g"}(DateFormat||(DateFormat={}));export var NumberFormat;!function(T){T.NUMBER="n",T.FIXED_POINT="f",T.CURRENCY="c",T.ACCOUNTING="a",T.PERCENT="p",T.ROUND_TRIP="r",T.DEFAULT="f"}(NumberFormat||(NumberFormat={}));export var TimeFormat;!function(T){T.TIME_SHORT="t",T.TIME_LONG="T",T.ISO_8601="u",T.ROUND_TRIP="u",T.DEFAULT="t"}(TimeFormat||(TimeFormat={}));

package/utilities/format/number.d.ts

@@ -0,0 +1,193 @@
+import type { PropertyDefs } from "../../support/Serializable.js";
+import { SerializableBase } from "../../support/Serializable.js";
+/**
+ * Default settings that affect how numbers are formatted and parsed.
+ */
+export interface NumberSettings {
+    /**
+     * The default format for formatting numbers. See
+     * {@link utilities/format/number!NumberFormatter.format}.
+     */
+    defaultFormat?: string;
+    /**
+     * Either a single format, or one of several possible formats that the input
+     * is expected to be in. If specified, the input must _exactly_ match. The
+     * syntax is the same as for
+     * {@link utilities/format/number!NumberFormatter.format}.
+     */
+    defaultParseFormat?: string | string[];
+    /**
+     * The 3-letter ISO 4217 currency code (e.g "USD", "CAD"). Required when
+     * formatting a number using NumberFormat.CURRENCY or
+     * NumberFormat.ACCOUNTING.
+     */
+    currency?: string;
+    /**
+     * The number of digits to show after the decimal point. If unspecified, an
+     * appropriate value is determined based on the locale and currency.
+     */
+    fractionalDigits?: number;
+}
+/**
+ * Options supported by {@link format}.
+ */
+export interface FormatOptions {
+    /**
+     * The locale to use when formatting the number. If not specified, the
+     * current locale is used (see locale module).
+     */
+    locale?: string;
+    /**
+     * The number format. See
+     * {@link utilities/format/number!NumberFormatter.format}.
+     */
+    format?: string;
+    /**
+     * See {@link NumberSettings.currency}.
+     */
+    currency?: string;
+    /**
+     * See {@link NumberSettings.fractionalDigits}.
+     */
+    fractionalDigits?: number;
+}
+/**
+ * Options supported by {@link parse}.
+ */
+export interface ParseOptions {
+    /**
+     * The locale to use when parsing the number. If not specified, the current
+     * locale is used (see locale module).
+     */
+    locale?: string;
+    /**
+     * Either a single format, or one of several possible formats that the input
+     * is expected to be in. If specified, the input must _exactly_ match. See
+     * {@link NumberFormatter.format}.
+     */
+    format?: string | string[];
+}
+/**
+ * Formats a number for display in the current locale.
+ *
+ * @param num The number to format.
+ */
+export declare function format(num: number): string;
+/**
+ * Formats a number for display.
+ *
+ * @param format See {@link utilities/format/number!NumberFormatter.format}.
+ * @param num The number to format.
+ */
+export declare function format(format: string, num: number): string;
+/**
+ * Formats a number for display.
+ *
+ * @param options Specifies the format settings to use.
+ * @param num The number to format.
+ */
+export declare function format(options: FormatOptions, num: number): string;
+/**
+ * Parses a value into a number.
+ *
+ * @param input The input to parse.
+ * @returns A number corresponding to the input, or NaN if the input can't be
+ *   parsed.
+ */
+export declare function parse(input: unknown): number;
+/**
+ * Parses a value into a number.
+ *
+ * @param format See {@link ParseOptions.format}.
+ * @param input The input to parse.
+ * @returns A number corresponding to the input, or NaN if the input can't be
+ *   parsed.
+ */
+export declare function parse(format: string | string[], input: unknown): number;
+/**
+ * Parses a value into a number.
+ *
+ * @param options The options to use for parsing.
+ * @param input The input to parse.
+ * @returns A number corresponding to the input, or NaN if the input can't be
+ *   parsed.
+ */
+export declare function parse(options: ParseOptions, input: unknown): number;
+/**
+ * Properties that can be passed into the constructor for
+ * {@link utilities/format/number!NumberFormatter}.
+ */
+export interface NumberFormatterProperties extends NumberSettings {
+    /**
+     * The locale to use when formatting & parsing the number. If not specified,
+     * the current locale is used (see locale module).
+     */
+    locale?: string;
+}
+/**
+ * A helper class for formatting and parsing numbers.
+ */
+export declare class NumberFormatter extends SerializableBase<NumberFormatterProperties> implements NumberSettings {
+    /**
+     * @inheritDoc
+     */
+    get defaultFormat(): string;
+    set defaultFormat(defaultFormat: string);
+    /**
+     * @inheritDoc
+     */
+    get defaultParseFormat(): string;
+    set defaultParseFormat(defaultParseFormat: string);
+    /**
+     * @inheritDoc
+     */
+    get currency(): string;
+    set currency(currency: string);
+    /**
+     * @inheritDoc
+     */
+    get fractionalDigits(): number;
+    set fractionalDigits(fractionalDigits: number);
+    /**
+     * The locale to use when formatting & parsing the number. If not specified,
+     * the current locale is used (see locale module).
+     */
+    locale: string;
+    private _defaultFormat;
+    private _defaultParseFormat;
+    private _currency;
+    private _fractionalDigits;
+    /**
+     * See {@link format}.
+     */
+    format(format: string, num: number): string;
+    format(options: FormatOptions, num: number): string;
+    format(num: number): string;
+    /**
+     * See {@link parse}.
+     */
+    parse(input: unknown): number;
+    parse(format: string | string[], input: unknown): number;
+    parse(options: ParseOptions, input: unknown): number;
+    protected _getSerializableProperties(): PropertyDefs<NumberFormatterProperties>;
+    /**
+     * Converts a format string accepted by formatNumber() to formatter
+     * function.
+     *
+     * @param inputLocales The locale.
+     * @param format The format to use.
+     * @param defaultOptions Options that control how values are formatted.
+     */
+    private _createNumberFormatter;
+    /**
+     * Create a numeric parser function for a set of locales.
+     *
+     * @param inputLocales An ordered array of locales to be used for parsing
+     *   sorted in order of precedence.
+     */
+    private _createNumberParser;
+}
+/**
+ * Default settings used for formatting and parsing numbers.
+ */
+export declare const settings: NumberSettings;