import type { FormatSettings } from "@vertigis/arcgis-extensions/utilities/FormatSettings";
/**
 * A translatable string, either a language string or a language string with
 * arguments to pass into it.
 */
export type TranslatableText = string | TranslateOptions;
/**
 * The available options for the Locale Service translate function.
 */
export interface TranslateOptions extends FormatSettings {
    /**
     * An optional default value to fallback to when a language resource key
     * does not exist. Web only.
     *
     * @webOnly
     */
    defaultValue?: string;
    /**
     * The string to translate. If the text is a language resource key, then a
     * localized version of that resource will be used if one exists, otherwise
     * the original text is returned.
     */
    text: string;
    /**
     * The locale to use for translation. If not specified, the current locale
     * will be used.
     */
    locale?: string;
    /**
     * The values to substitute into the format string if it contains
     * substitution placeholders (see utilities/string/format in ArcGIS
     * Extensions API).
     */
    args?: unknown[];
}
