@v4fire/core/src/core/prelude/i18n/interface.ts

V4Fire core library

/*!
 * V4Fire Core
 * https://github.com/V4Fire/Core
 *
 * Released under the MIT license
 * https://github.com/V4Fire/Core/blob/master/LICENSE
 */

import type { SyncStorage } from 'core/kv-storage';

export interface Locale {
	/**
	 * The locale value
	 */
	value: CanUndef<Language>;

	/**
	 * True if the locale is default
	 */
	isDefault: boolean;
}

export interface RegionStore {
	/**
	 * The region value
	 */
	value: CanUndef<Region>;

	/**
	 * True if the region is default
	 */
	isDefault: boolean;
}

export interface LocaleKVStorage {
	get: SyncStorage['get'];

	/**
	 * Set is optional for read only storage
	 */
	set?: SyncStorage['set'];
}

export type PluralizationCount = StringPluralizationForms | number;

export interface I18nMeta {
	language: string;
	key: string;
	keyset?: string;
}

export interface I18nOpts {
	pluralRules?: Intl.PluralRules;
	meta?: I18nMeta;
}