import type { CollectionHolder } from "@joookiwi/collection"; import type { NullOr, PossibleEdgeCaseNumericName } from "@joookiwi/type"; import type { Enumerable } from "./Enumerable"; import type { EnumerableConstructor } from "./EnumerableConstructor"; import type { CompanionEnumerableType } from "./type/companion"; import type { KeyOfCompanionEnum, KeyOfCompanionEnumWithGrandParent, KeyOfCompanionEnumWithGreatGrandParent, KeyOfCompanionEnumWithParent, KeyOfEnumerable, KeyOfEnumerableWithGrandParent, KeyOfEnumerableWithGreatGrandParent, KeyOfEnumerableWithParent } from "./type/keyOf"; /** A class containing every field used by an {@link Enumerable} helper, instance or companion */ export declare class EnumConstants { private constructor(); } export declare namespace EnumConstants { /** * A map of every {@link CompanionEnumerable.default default} stored from a {@link CompanionEnumerable} * * @see CompanionEnumerable.defaultValue */ const DEFAULT_MAP: Map>, NullOr>>; /** * A map of every {@link Enumerable} {@link CompanionEnumerable.values values} stored from a {@link CompanionEnumerable} * * @see CompanionEnumerable.values */ const VALUES_MAP: Map>, CollectionHolder>>; /** * A map of an individual {@link Enumerable.name name} associated to a {@link Enumerable} * * @see Enumerable.name */ const NAME_MAP: Map, string>; /** * A map of every {@link Enumerable} {@link CompanionEnumerable.names names} stored from a {@link CompanionEnumerable} * * @see CompanionEnumerable.names */ const NAMES_MAP: Map>, CollectionHolder>; /** * A map of the last ordinal of {@link Enum} instance * * @see Enum.constructor */ const LAST_ORDINAL_MAP: Map, CompanionEnumerableType>>, number>; /** * A map of an individual {@link Enumerable.ordinal ordinal} associated to a {@link Enumerable} * * @see Enumerable.ordinal */ const ORDINAL_MAP: Map, number>; /** * A map of every {@link Enumerable} {@link CompanionEnumerable.ordinals ordinals} stored from a {@link CompanionEnumerable} * * @see CompanionEnumerable.ordinals */ const ORDINALS_MAP: Map>, CollectionHolder>; /** * The prototype name of a class * * @uniqueToJavascript */ const PROTOTYPE_NAME = "prototype"; /** Every edge case of a {@link Number} */ const EDGE_CASE_NUMERIC_NAMES: CollectionHolder; /** * The insensitive hint used on the {@link Enumerable}{@link Symbol.toPrimitive [Symbol.toPrimitive]}() * * @uniqueToJavascript */ const TO_PRIMITIVE_VALUES: RegExp; /** * A {@link RegExp regex} to include any {@link Number numeric} * in the decimal form (±0.1 or ±10 or ±100_000) */ const DECIMAL_REGEX: RegExp; /** * A {@link RegExp regex} to include any {@link Number integer} * in the decimal form (±10 or ±100_000) */ const INTEGER_REGEX: RegExp; /** * A {@link RegExp regex} to include any {@link Number numeric} * in the exponential form (±1e10, ±1e±10, ±1.1e10 or ±1.1e±10). * * This will be an eventual valid regex in the {@link CompanionEnum companion enum}. */ const EXPONENTIAL_REGEX: RegExp; /** * A {@link RegExp regex} to include any {@link Number numeric} * in the exponential form (±1¹⁰, ±1⁻¹⁰ or ±1⁺¹⁰). * * This will be an eventual valid regex in the {@link CompanionEnum companion enum}. */ const UNICODE_EXPONENTIAL_REGEX: RegExp; /** * A {@link RegExp regex} to include any {@link Number numeric} * in the hexadecimal form (±0x1a). * * This will be an eventual valid regex in the {@link CompanionEnum companion enum}. */ const HEXADECIMAL_REGEX: RegExp; /** * A {@link RegExp regex} to include any {@link Number numeric} * in the binary form (±0x1001). * * This will be an eventual valid regex in the {@link CompanionEnum companion enum}. */ const BINARY_REGEX: RegExp; /** The maximum value (2³¹ - 1) represented as a {@link Number} */ const MAX_VALUE_AS_NUMBER = 2147483647; /** The maximum value (2³¹ - 1) represented as a {@link BigInt} */ const MAX_VALUE_AS_BIG_INT = 2147483647n; /** * The max value (2³¹ - 1) size (amount of numbers). * * This is the equivalent of: * * ({@link Math}.{@link Math.log log}({@link Math}.{@link Math.abs abs}({@link MAX_VALUE_AS_NUMBER 2_147_483_647}) + 1) * * {@link Math}.{@link Math.LOG10E LOG10E} | 0) + 1 */ const MAX_VALUE_SIZE = 10; /** Every member of an {@link Enumerable} */ const ENUMERABLE_MEMBERS: CollectionHolder; /** Every member of an {@link EnumerableWithNullableParent} or {@link EnumerableWithParent} */ const ENUMERABLE_WITH_PARENT_MEMBERS: CollectionHolder; /** Every member of an {@link EnumerableWithNullableGrandParent} or {@link EnumerableWithGrandParent} */ const ENUMERABLE_WITH_GRAND_PARENT_MEMBERS: CollectionHolder; /** Every member of an {@link EnumerableWithNullableGreatGrandParent} or {@link EnumerableWithGreatGrandParent} */ const ENUMERABLE_WITH_GREAT_GRAND_PARENT_MEMBERS: CollectionHolder; /** Every member of a {@link CompanionEnumerable} */ const COMPANION_ENUM_MEMBERS: CollectionHolder; /** Every member of a {@link CompanionEnumerableWithParent} */ const COMPANION_ENUM_WITH_PARENT_MEMBERS: CollectionHolder; /** Every member of a {@link CompanionEnumerableWithGrandParent} */ const COMPANION_ENUM_WITH_GRAND_PARENT_MEMBERS: CollectionHolder; /** Every member of a {@link CompanionEnumerableWithGreatGrandParent} */ const COMPANION_ENUM_WITH_GREAT_GRAND_PARENT_MEMBERS: CollectionHolder; /** * Every member of * - {@link Enumerable}, * - {@link EnumerableWithNullableParent}, * - {@link EnumerableWithParent}, * - {@link EnumerableWithNullableGrandParent}, * - {@link EnumerableWithGrandParent}, * - {@link EnumerableWithNullableGreatGrandParent} * - {@link EnumerableWithGreatGrandParent} * * @deprecated Replace with {@link EnumConstants.ENUMERABLE_WITH_GREAT_GRAND_PARENT_MEMBERS} instead. This will be removed in version 3.14. */ const EVERY_ENUMERABLE_MEMBERS: CollectionHolder>; /** * A representation of the {@link EVERY_ENUMERABLE_MEMBERS} joined together as a single string * for the Javascript implementation * * @deprecated This will be removed in version 3.14 since it does not have a great use within the framework. */ const EVERY_ENUMERABLE_MEMBERS_JOINED = "(\u201Cname\u201D, \u201Cordinal\u201D, \u201Cparent\u201D, \u201CgrandParent\u201D, \u201CgreatGrandParent\u201D, \u201C[Symbol.toPrimitive]\u201D, \u201C[Symbol.toStringTag]\u201D)"; /** * Every member of * - {@link CompanionEnumerable}, * - {@link CompanionEnumerableWithParent}, * - {@link CompanionEnumerableWithGrandParent}, * - {@link CompanionEnumerableWithGreatGrandParent} * * @deprecated Replace with {@link EnumConstants.COMPANION_ENUM_WITH_GREAT_GRAND_PARENT_MEMBERS} instead. This will be removed in version 3.14. */ const EVERY_COMPANION_ENUM_MEMBERS: CollectionHolder>; /** * A representation of the {@link EVERY_COMPANION_ENUM_MEMBERS} joined together as a single string * for the Javascript implementation * * @deprecated This will be removed in version 3.14 since it does not have a great use within the framework. */ const EVERY_COMPANION_ENUM_MEMBERS_JOINED = "(\u201Cinstance\u201D, \u201CparentInstance\u201D, \u201CgrandParentInstance\u201D, \u201CgreatGrandParentInstance\u201D, \u201CdefaultValue\u201D, \u201CsetDefaultValue\u201D, \u201Cvalues\u201D, \u201Cnames\u201D, \u201Cordinals\u201D, \u201Citerator\u201D, \u201CgetValue\u201D, \u201CgetName\u201D, \u201CgetOrdinal\u201D, \u201C[Symbol.iterator]\u201D, \u201C[Symbol.toStringTag]\u201D)"; /** * Tell that the {@link Enumerable} reference will be similar to another {@link Enumerable.name} * * @uniqueToJavascript */ const ENUM_REFERENCE_BY_ITS_NAME_SYMBOL: unique symbol; /** * Tell that the {@link Enumerable} reference will be `null` * * @uniqueToJavascript * @see EnumerableWithNullableParent * @see EnumerableWithNullableGrandParent * @see EnumerableWithNullableGreatGrandParent * @see EnumWithNullableParent * @see EnumWithNullableGrandParent * @see EnumWithNullableGreatGrandParent */ const NULL_ENUM_REFERENCE_SYMBOL: unique symbol; /** * The {@link Symbol.toStringTag} of an {@link Enum} * * @uniqueToJavascript */ const ENUM_TO_STRING_TAG = "Enum"; /** * The {@link Symbol.toStringTag} of a companion enum * ({@link CompanionEnumerable}, {@link CompanionEnumerableWithParent}, {@link CompanionEnumerableWithGrandParent}, {@link CompanionEnumerableWithGreatGrandParent}) * * @uniqueToJavascript */ const COMPANION_ENUM_TO_STRING_TAG = "CompanionEnum"; } export interface EnumConstants { /** * @param args Any possible arguments sent * @throws EvalError The class cannot be constructed */ new (...args: readonly unknown[]): never; } //# sourceMappingURL=EnumConstants.d.ts.map