typia 5.0.0-dev.20230715 → 5.0.0-dev.20230726

package/src/module.ts

@@ -1,781 +1,781 @@
-import { $dictionary } from "./functional/$dictionary";
-import { Namespace } from "./functional/Namespace";
-
-import { IMetadataApplication } from "./metadata/IMetadataApplication";
-
-import { MapUtil } from "./utils/MapUtil";
-
-import { CustomValidatorMap } from "./CustomValidatorMap";
-import { IRandomGenerator } from "./IRandomGenerator";
-import { IValidation } from "./IValidation";
-import { Primitive } from "./Primitive";
-
-export * as json from "./json";
-export * as protobuf from "./protobuf";
-export * as misc from "./misc";
-
-export * from "./schemas/IJsonApplication";
-export * from "./schemas/IJsonComponents";
-export * from "./schemas/IJsonSchema";
-export * from "./IRandomGenerator";
-export * from "./IValidation";
-export * from "./Primitive";
-export * from "./TypeGuardError";
-
-/**
- * Custom validators.
- *
- * If you want to add a custom validation logic utilizing comment tags,
- * add a closure function with its tag and type name. Below example code
- * would helpful to understand how to use this instance.
- *
- * ```ts
- * typia.customValidators.insert("powerOf")("number")(
- *     (text: string) => {
- *         const denominator: number = Math.log(Number(text));
- *         return (value: number) => {
- *             value = Math.log(value) / denominator;
- *             return value === Math.floor(value);
- *         };
- *     }
- * );
- * typia.customValidators.insert("dollar")("string")(
- *     () => (value: string) => value.startsWith("$"),
- * );
- *
- * interface TagCustom {
- *    /**
- *     * @powerOf 10
- *     *\/
- *    powerOf: number;
- *
- *    /**
- *     * @dollar
- *     *\/
- *    dollar: string;
- * }
- * ```
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export const customValidators: CustomValidatorMap = {
-    size: (name?: string) =>
-        name ? $dictionary.get(name)?.size ?? 0 : $dictionary.size,
-    has: (name) => (type) => $dictionary.get(name)?.has(type) ?? false,
-    get: (name) => (type) => $dictionary.get(name)?.get(type),
-    insert: (name) => (type) => (closure) => {
-        const internal = MapUtil.take($dictionary)(name, () => new Map());
-        if (internal.has(type)) return false;
-        internal.set(type, closure);
-        return true;
-    },
-    erase: (name) => (type) => $dictionary.get(name)?.delete(type) ?? false,
-};
-
-/* -----------------------------------------------------------
-    BASIC VALIDATORS
------------------------------------------------------------ */
-/**
- * Asserts a value type.
- *
- * Asserts a parametric value type and throws a {@link TypeGuardError} with detailed
- * reason, if the parametric value is not following the type `T`. Otherwise, the
- * value is following the type `T`, just input parameter would be returned.
- *
- * If what you want is not asserting but just knowing whether the parametric value is
- * following the type `T` or not, you can choose the {@link is} function instead.
- * Otherwise you want to know all the errors, {@link validate} is the way to go.
- *
- * On the other and, if you don't want to allow any superfluous property that is not
- * enrolled to the type `T`, you can use {@link assertEquals} function instead.
- *
- * @template T Type of the input value
- * @param input A value to be asserted
- * @returns Parametric input value
- * @throws A {@link TypeGuardError} instance with detailed reason
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export function assert<T>(input: T): T;
-
-/**
- * Asserts a value type.
- *
- * Asserts a parametric value type and throws a {@link TypeGuardError} with detailed
- * reason, if the parametric value is not following the type `T`. Otherwise, the
- * value is following the type `T`, just input parameter would be returned.
- *
- * If what you want is not asserting but just knowing whether the parametric value is
- * following the type `T` or not, you can choose the {@link is} function instead.
- * Otherwise, you want to know all the errors, {@link validate} is the way to go.
- *
- * On the other and, if you don't want to allow any superfluous property that is not
- * enrolled to the type `T`, you can use {@link assertEquals} function instead.
- *
- * @template T Type of the input value
- * @param input A value to be asserted
- * @returns Parametric input value casted as `T`
- * @throws A {@link TypeGuardError} instance with detailed reason
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export function assert<T>(input: unknown): T;
-
-/**
- * @internal
- */
-export function assert(): never {
-    halt("assert");
-}
-Object.assign(assert, Namespace.assert("assert"));
-
-/**
- * Asserts a value type.
- *
- * Duplicated function of {@link assert} for `typescript-is` users.
- *
- * @template T Type of the input value
- * @param input A value to be asserted
- * @returns Parametric input value
- * @throws A {@link TypeGuardError} instance with detailed reason
- *
- * @author Jeongho Nam - https://github.com/samchon
- * @deprecated
- */
-export function assertType<T>(input: T): T;
-
-/**
- * Asserts a value type.
- *
- * Duplicated function of {@link assert} for `typescript-is` users.
- *
- * @template T Type of the input value
- * @param input A value to be asserted
- * @returns Parametric input value
- * @throws A {@link TypeGuardError} instance with detailed reason
- *
- * @author Jeongho Nam - https://github.com/samchon
- * @deprecated
- */
-export function assertType<T>(input: unknown): T;
-
-/**
- * @internal
- */
-export function assertType(): never {
-    halt("assertType");
-}
-Object.assign(assertType, Namespace.assert("assertType"));
-
-/**
- * Tests a value type.
- *
- * Tests a parametric value type and returns whether it's following the type `T` or not.
- * If the parametric value is matched with the type `T`, `true` value would be returned.
- * Otherwise, the parametric value is not following the type `T`, `false` value would be
- * returned.
- *
- * If what you want is not just knowing whether the parametric value is following the
- * type `T` or not, but throwing an exception with detailed reason, you can choose
- * {@link assert} function instead. Also, if you want to know all the errors with
- * detailed reasons, {@link validate} function would be useful.
- *
- * On the other and, if you don't want to allow any superfluous property that is not
- * enrolled to the type `T`, you can use {@link equals} function instead.
- *
- * @template T Type of the input value
- * @param input A value to be tested
- * @returns Whether the parametric value is following the type `T` or not
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export function is<T>(input: T): input is T;
-
-/**
- * Tests a value type.
- *
- * Tests a parametric value type and returns whether it's following the type `T` or not.
- * If the parametric value is matched with the type `T`, `true` value would be returned.
- * Otherwise, the parametric value is not following the type `T`, `false` value would be
- * returned.
- *
- * If what you want is not just knowing whether the parametric value is following the
- * type `T` or not, but throwing an exception with detailed reason, you can choose
- * {@link assert} function instead. Also, if you want to know all the errors with
- * detailed reasons, {@link validate} function would be useful.
- *
- * On the other and, if you don't want to allow any superfluous property that is not
- * enrolled to the type `T`, you can use {@link equals} function instead.
- *
- * @template T Type of the input value
- * @param input A value to be tested
- * @returns Whether the parametric value is following the type `T` or not
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export function is<T>(input: unknown): input is T;
-
-/**
- * @internal
- */
-export function is(): never {
-    halt("is");
-}
-Object.assign(is, Namespace.assert("is"));
-
-/**
- * Validates a value type.
- *
- * Validates a parametric value type and archives all the type errors into an
- * {@link IValidation.errors} array, if the parametric value is not following the
- * type `T`. Of course, if the parametric value is following the type `T`, the
- * {@link IValidation.errors} array would be empty and {@link IValidation.success}
- * would have the `true` value.
- *
- * If what you want is not finding all the error, but asserting the parametric value
- * type with exception throwing, you can choose {@link assert} function instead.
- * Otherwise, you just want to know whether the parametric value is matched with the
- * type `T`, {@link is} function is the way to go.
- *
- * On the other and, if you don't want to allow any superfluous property that is not
- * enrolled to the type `T`, you can use {@link validateEquals} function instead.
- *
- * @template Type of the input value
- * @param input A value to be validated
- * @returns Validation result
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export function validate<T>(input: T): IValidation<T>;
-
-/**
- * Validates a value type.
- *
- * Validates a parametric value type and archives all the type errors into an
- * {@link IValidation.errors} array, if the parametric value is not following the
- * type `T`. Of course, if the parametric value is following the type `T`, the
- * {@link IValidation.errors} array would be empty and {@link IValidation.success}
- * would have the `true` value.
- *
- * If what you want is not finding all the error, but asserting the parametric value
- * type with exception throwing, you can choose {@link assert} function instead.
- * Otherwise, you just want to know whether the parametric value is matched with the
- * type `T`, {@link is} function is the way to go.
- *
- * On the other and, if you don't want to allow any superfluous property that is not
- * enrolled to the type `T`, you can use {@link validateEquals} function instead.
- *
- * @template Type of the input value
- * @param input A value to be validated
- * @returns Validation result
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export function validate<T>(input: unknown): IValidation<T>;
-
-/**
- * @internal
- */
-export function validate(): never {
-    halt("validate");
-}
-Object.assign(validate, Namespace.validate());
-
-/* -----------------------------------------------------------
-    STRICT VALIDATORS
------------------------------------------------------------ */
-/**
- * Asserts equality between a value and its type.
- *
- * Asserts a parametric value type and throws a {@link TypeGuardError} with detailed
- * reason, if the parametric value is not following the type `T` or some superfluous
- * property that is not listed on the type `T` has been found. Otherwise, the value is
- * following the type `T` without any superfluous property, just input parameter would
- * be returned.
- *
- * If what you want is not asserting but just knowing whether the parametric value is
- * following the type `T` or not, you can choose the {@link equals} function instead.
- * Otherwise, you want to know all the errors, {@link validateEquals} is the way to go.
- *
- * On the other hand, if you want to allow superfluous property that is not enrolled
- * to the type `T`, you can use {@link assert} function instead.
- *
- * @template T Type of the input value
- * @param input A value to be asserted
- * @returns Parametric input value
- * @throws A {@link TypeGuardError} instance with detailed reason
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export function assertEquals<T>(input: T): T;
-
-/**
- * Asserts equality between a value and its type.
- *
- * Asserts a parametric value type and throws a {@link TypeGuardError} with detailed
- * reason, if the parametric value is not following the type `T` or some superfluous
- * property that is not listed on the type `T` has been found. Otherwise, the value is
- * following the type `T` without any superfluous property, just input parameter would
- * be returned.
- *
- * If what you want is not asserting but just knowing whether the parametric value is
- * following the type `T` or not, you can choose the {@link equals} function instead.
- * Otherwise, you want to know all the errors, {@link validateEquals} is the way to go.
- *
- * On the other hand, if you want to allow superfluous property that is not enrolled
- * to the type `T`, you can use {@link assert} function instead.
- *
- * @template T Type of the input value
- * @param input A value to be asserted
- * @returns Parametric input value casted as `T`
- * @throws A {@link TypeGuardError} instance with detailed reason
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export function assertEquals<T>(input: unknown): T;
-
-/**
- * @internal
- */
-export function assertEquals(): never {
-    halt("assertEquals");
-}
-Object.assign(assertEquals, Namespace.assert("assertEquals"));
-
-/**
- * Tests equality between a value and its type.
- *
- * Tests a parametric value type and returns whether it's equivalent to the type `T`
- * or not. If the parametric value is matched with the type `T` and there's not any
- * superfluous property that is not listed on the type `T`, `true` value would be
- * returned. Otherwise, the parametric value is not following the type `T` or some
- * superfluous property exists, `false` value would be returned.
- *
- * If what you want is not just knowing whether the parametric value is following the
- * type `T` or not, but throwing an exception with detailed reason, you can choose
- * {@link assertEquals} function instead. Also, if you want to know all the errors with
- * detailed reasons, {@link validateEquals} function would be useful.
- *
- * On the other hand, if you want to allow superfluous property that is not enrolled
- * to the type `T`, you can use {@link is} function instead.
- *
- * @template T Type of the input value
- * @param input A value to be tested
- * @returns Whether the parametric value is equivalent to the type `T` or not
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export function equals<T>(input: T): input is T;
-
-/**
- * Tests equality between a value and its type.
- *
- * Tests a parametric value type and returns whether it's equivalent to the type `T`
- * or not. If the parametric value is matched with the type `T` and there's not any
- * superfluous property that is not listed on the type `T`, `true` value would be
- * returned. Otherwise, the parametric value is not following the type `T` or some
- * superfluous property exists, `false` value would be returned.
- *
- * If what you want is not just knowing whether the parametric value is following the
- * type `T` or not, but throwing an exception with detailed reason, you can choose
- * {@link assertEquals} function instead. Also, if you want to know all the errors with
- * detailed reasons, {@link validateEquals} function would be useful.
- *
- * On the other hand, if you want to allow superfluous property that is not enrolled
- * to the type `T`, you can use {@link is} function instead.
- *
- * @template T Type of the input value
- * @param input A value to be tested
- * @returns Whether the parametric value is equivalent to the type `T` or not
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export function equals<T>(input: unknown): input is T;
-
-/**
- * @internal
- */
-export function equals(): never {
-    halt("equals");
-}
-Object.assign(equals, Namespace.is());
-
-/**
- * Validates equality between a value and its type.
- *
- * Validates a parametric value type and archives all the type errors into an
- * {@link IValidation.errors} array, if the parametric value is not following the
- * type `T` or some superfluous property that is not listed on the type `T` has been
- * found. Of course, if the parametric value is following the type `T` and no
- * superfluous property exists, the {@link IValidation.errors} array would be empty
- * and {@link IValidation.success} would have the `true` value.
- *
- * If what you want is not finding all the error, but asserting the parametric value
- * type with exception throwing, you can choose {@link assert} function instead.
- * Otherwise, you just want to know whether the parametric value is matched with the
- * type `T`, {@link is} function is the way to go.
- *
- * On the other and, if you don't want to allow any superfluous property that is not
- * enrolled to the type `T`, you can use {@link validateEquals} function instead.
- *
- * @template Type of the input value
- * @param input A value to be validated
- * @returns Validation result
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export function validateEquals<T>(input: T): IValidation<T>;
-
-/**
- * Validates equality between a value and its type.
- *
- * Validates a parametric value type and archives all the type errors into an
- * {@link IValidation.errors} array, if the parametric value is not following the
- * type `T` or some superfluous property that is not listed on the type `T` has been
- * found. Of course, if the parametric value is following the type `T` and no
- * superfluous property exists, the {@link IValidation.errors} array would be empty
- * and {@link IValidation.success} would have the `true` value.
- *
- * If what you want is not finding all the error, but asserting the parametric value
- * type with exception throwing, you can choose {@link assert} function instead.
- * Otherwise, you just want to know whether the parametric value is matched with the
- * type `T`, {@link is} function is the way to go.
- *
- * On the other and, if you don't want to allow any superfluous property that is not
- * enrolled to the type `T`, you can use {@link validateEquals} function instead.
- *
- * @template Type of the input value
- * @param input A value to be validated
- * @returns Validation result
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export function validateEquals<T>(input: unknown): IValidation<T>;
-
-/**
- * @internal
- */
-export function validateEquals(): never {
-    halt("validateEquals");
-}
-Object.assign(validateEquals, Namespace.validate());
-
-/* -----------------------------------------------------------
-    RANDOM
------------------------------------------------------------ */
-/**
- * > You must configure the generic argument `T`.
- *
- * Generate random data.
- *
- * Generates a random data following type the `T`.
- *
- * For reference, this `typia.random()` function generates only primitive type.
- * If there're some methods in the type `T` or its nested instances, those would
- * be ignored. Also, when the type `T` has a `toJSON()` method, its return type
- * would be generated instead.
- *
- * @template T Type of data to generate
- * @param generator Random data generator
- * @return Randomly generated data
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export function random(generator?: Partial<IRandomGenerator>): never;
-
-/**
- * Generate random data.
- *
- * Generates a random data following type the `T`.
- *
- * For reference, this `typia.random()` function generates only primitive type.
- * If there're some methods in the type `T` or its nested instances, those would
- * be ignored. Also, when the type `T` has a `toJSON()` method, its return type
- * would be generated instead.
- *
- * @template T Type of data to generate
- * @param generator Random data generator
- * @return Randomly generated data
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export function random<T>(generator?: Partial<IRandomGenerator>): Primitive<T>;
-
-/**
- * @internal
- */
-export function random(): never {
-    halt("random");
-}
-Object.assign(random, Namespace.random());
-
-/**
- * @internal
- */
-export function metadata(): never;
-
-/**
- * @internal
- */
-export function metadata<Types extends unknown[]>(): IMetadataApplication;
-
-/**
- * @internal
- */
-export function metadata(): never {
-    halt("metadata");
-}
-
-/* -----------------------------------------------------------
-    FACTORY FUNCTIONS
------------------------------------------------------------ */
-/**
- * Creates a reusable {@link assert} function.
- *
- * @danger You have to specify the generic argument `T`
- * @return Nothing until specifying the generic argument `T`
- * @throws compile error
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export function createAssert(): never;
-
-/**
- * Creates a reusable {@link assert} function.
- *
- * @template T Type of the input value
- * @returns A reusable `assert` function
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export function createAssert<T>(): (input: unknown) => T;
-
-/**
- * @internal
- */
-export function createAssert<T>(): (input: unknown) => T {
-    halt("createAssert");
-}
-Object.assign(createAssert, assert);
-
-/**
- * Creates a reusable {@link assertType} function.
- *
- * Duplicated function of {@link createAssert} for `typescript-is` users.
- *
- * @danger You have to specify the generic argument `T`
- * @return Nothing until specifying the generic argument `T`
- * @throws compile error
- *
- * @author Jeongho Nam - https://github.com/samchon
- * @deprecated
- */
-export function createAssertType(): never;
-
-/**
- * Creates a reusable {@link assertType} function.
- *
- * Duplicated function of {@link createAssert} for `typescript-is` users.
- *
- * @template T Type of the input value
- * @returns A reusable `assert` function
- *
- * @author Jeongho Nam - https://github.com/samchon
- * @deprecated
- */
-export function createAssertType<T>(): (input: unknown) => T;
-
-/**
- * @internal
- */
-export function createAssertType<T>(): (input: unknown) => T {
-    halt("createAssertType");
-}
-Object.assign(createAssertType, assertType);
-
-/**
- * Creates a reusable {@link is} function.
- *
- * @danger You have to specify the generic argument `T`
- * @return Nothing until specifying the generic argument `T`
- * @throws compile error
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export function createIs(): never;
-
-/**
- * Creates a reusable {@link is} function.
- *
- * @template T Type of the input value
- * @returns A reusable `is` function
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export function createIs<T>(): (input: unknown) => input is T;
-
-/**
- * @internal
- */
-export function createIs<T>(): (input: unknown) => input is T {
-    halt("createIs");
-}
-Object.assign(createIs, is);
-
-/**
- * Creates a reusable {@link validate} function.
- *
- * @danger You have to specify the generic argument `T`
- * @return Nothing until specifying the generic argument `T`
- * @throws compile error
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export function createValidate(): never;
-
-/**
- * Creates a reusable {@link validate} function.
- *
- * @template T Type of the input value
- * @returns A reusable `validate` function
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export function createValidate<T>(): (input: unknown) => IValidation<T>;
-
-/**
- * @internal
- */
-export function createValidate(): (input: unknown) => IValidation {
-    halt("createValidate");
-}
-Object.assign(createValidate, validate);
-
-/**
- * Creates a reusable {@link assertEquals} function.
- *
- * @danger You have to specify the generic argument `T`
- * @return Nothing until specifying the generic argument `T`
- * @throws compile error
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export function createAssertEquals(): never;
-
-/**
- * Creates a reusable {@link assertEquals} function.
- *
- * @template T Type of the input value
- * @returns A reusable `assertEquals` function
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export function createAssertEquals<T>(): (input: unknown) => T;
-
-/**
- * @internal
- */
-export function createAssertEquals<T>(): (input: unknown) => T {
-    halt("createAssertEquals");
-}
-Object.assign(createAssertEquals, assertEquals);
-
-/**
- * Creates a reusable {@link equals} function.
- *
- * @danger You have to specify the generic argument `T`
- * @return Nothing until specifying the generic argument `T`
- * @throws compile error
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export function createEquals(): never;
-
-/**
- * Creates a reusable {@link equals} function.
- *
- * @template T Type of the input value
- * @returns A reusable `equals` function
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export function createEquals<T>(): (input: unknown) => input is T;
-
-/**
- * @internal
- */
-export function createEquals<T>(): (input: unknown) => input is T {
-    halt("createEquals");
-}
-Object.assign(createEquals, equals);
-
-/**
- * Creates a reusable {@link validateEquals} function.
- *
- * @danger You have to specify the generic argument `T`
- * @return Nothing until specifying the generic argument `T`
- * @throws compile error
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export function createValidateEquals(): never;
-
-/**
- * Creates a reusable {@link validateEquals} function.
- *
- * @template T Type of the input value
- * @returns A reusable `validateEquals` function
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export function createValidateEquals<T>(): (input: unknown) => IValidation<T>;
-
-/**
- * @internal
- */
-export function createValidateEquals(): (input: unknown) => IValidation {
-    halt("createValidateEquals");
-}
-Object.assign(createValidateEquals, validateEquals);
-
-/**
- * Creates a reusable {@link random} function.
- *
- * @danger You have to specify the generic argument `T`
- * @param generator Random data generator
- * @return Nothing until specifying the generic argument `T`
- * @throws compile error
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export function createRandom(generator?: Partial<IRandomGenerator>): never;
-
-/**
- * Creates a resuable {@link random} function.
- *
- * @template T Type of the input value
- * @param generator Random data generator
- * @returns A reusable `random` function
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export function createRandom<T>(
-    generator?: Partial<IRandomGenerator>,
-): () => Primitive<T>;
-
-/**
- * @internal
- */
-export function createRandom(): never {
-    halt("createRandom");
-}
-Object.assign(createRandom, random);
-
-/**
- * @internal
- */
-function halt(name: string): never {
-    throw new Error(
-        `Error on typia.${name}(): no transform has been configured. Read and follow https://typia.io/docs/setup please.`,
-    );
-}
+import { $dictionary } from "./functional/$dictionary";
+import { Namespace } from "./functional/Namespace";
+
+import { IMetadataApplication } from "./schemas/metadata/IMetadataApplication";
+
+import { MapUtil } from "./utils/MapUtil";
+
+import { CustomValidatorMap } from "./CustomValidatorMap";
+import { IRandomGenerator } from "./IRandomGenerator";
+import { IValidation } from "./IValidation";
+import { Primitive } from "./Primitive";
+
+export * as json from "./json";
+export * as protobuf from "./protobuf";
+export * as misc from "./misc";
+
+export * from "./schemas/json/IJsonApplication";
+export * from "./schemas/json/IJsonComponents";
+export * from "./schemas/json/IJsonSchema";
+export * from "./IRandomGenerator";
+export * from "./IValidation";
+export * from "./Primitive";
+export * from "./TypeGuardError";
+
+/**
+ * Custom validators.
+ *
+ * If you want to add a custom validation logic utilizing comment tags,
+ * add a closure function with its tag and type name. Below example code
+ * would helpful to understand how to use this instance.
+ *
+ * ```ts
+ * typia.customValidators.insert("powerOf")("number")(
+ *     (text: string) => {
+ *         const denominator: number = Math.log(Number(text));
+ *         return (value: number) => {
+ *             value = Math.log(value) / denominator;
+ *             return value === Math.floor(value);
+ *         };
+ *     }
+ * );
+ * typia.customValidators.insert("dollar")("string")(
+ *     () => (value: string) => value.startsWith("$"),
+ * );
+ *
+ * interface TagCustom {
+ *    /**
+ *     * @powerOf 10
+ *     *\/
+ *    powerOf: number;
+ *
+ *    /**
+ *     * @dollar
+ *     *\/
+ *    dollar: string;
+ * }
+ * ```
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export const customValidators: CustomValidatorMap = {
+    size: (name?: string) =>
+        name ? $dictionary.get(name)?.size ?? 0 : $dictionary.size,
+    has: (name) => (type) => $dictionary.get(name)?.has(type) ?? false,
+    get: (name) => (type) => $dictionary.get(name)?.get(type),
+    insert: (name) => (type) => (closure) => {
+        const internal = MapUtil.take($dictionary)(name, () => new Map());
+        if (internal.has(type)) return false;
+        internal.set(type, closure);
+        return true;
+    },
+    erase: (name) => (type) => $dictionary.get(name)?.delete(type) ?? false,
+};
+
+/* -----------------------------------------------------------
+    BASIC VALIDATORS
+----------------------------------------------------------- */
+/**
+ * Asserts a value type.
+ *
+ * Asserts a parametric value type and throws a {@link TypeGuardError} with detailed
+ * reason, if the parametric value is not following the type `T`. Otherwise, the
+ * value is following the type `T`, just input parameter would be returned.
+ *
+ * If what you want is not asserting but just knowing whether the parametric value is
+ * following the type `T` or not, you can choose the {@link is} function instead.
+ * Otherwise you want to know all the errors, {@link validate} is the way to go.
+ *
+ * On the other and, if you don't want to allow any superfluous property that is not
+ * enrolled to the type `T`, you can use {@link assertEquals} function instead.
+ *
+ * @template T Type of the input value
+ * @param input A value to be asserted
+ * @returns Parametric input value
+ * @throws A {@link TypeGuardError} instance with detailed reason
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export function assert<T>(input: T): T;
+
+/**
+ * Asserts a value type.
+ *
+ * Asserts a parametric value type and throws a {@link TypeGuardError} with detailed
+ * reason, if the parametric value is not following the type `T`. Otherwise, the
+ * value is following the type `T`, just input parameter would be returned.
+ *
+ * If what you want is not asserting but just knowing whether the parametric value is
+ * following the type `T` or not, you can choose the {@link is} function instead.
+ * Otherwise, you want to know all the errors, {@link validate} is the way to go.
+ *
+ * On the other and, if you don't want to allow any superfluous property that is not
+ * enrolled to the type `T`, you can use {@link assertEquals} function instead.
+ *
+ * @template T Type of the input value
+ * @param input A value to be asserted
+ * @returns Parametric input value casted as `T`
+ * @throws A {@link TypeGuardError} instance with detailed reason
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export function assert<T>(input: unknown): T;
+
+/**
+ * @internal
+ */
+export function assert(): never {
+    halt("assert");
+}
+Object.assign(assert, Namespace.assert("assert"));
+
+/**
+ * Asserts a value type.
+ *
+ * Duplicated function of {@link assert} for `typescript-is` users.
+ *
+ * @template T Type of the input value
+ * @param input A value to be asserted
+ * @returns Parametric input value
+ * @throws A {@link TypeGuardError} instance with detailed reason
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ * @deprecated
+ */
+export function assertType<T>(input: T): T;
+
+/**
+ * Asserts a value type.
+ *
+ * Duplicated function of {@link assert} for `typescript-is` users.
+ *
+ * @template T Type of the input value
+ * @param input A value to be asserted
+ * @returns Parametric input value
+ * @throws A {@link TypeGuardError} instance with detailed reason
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ * @deprecated
+ */
+export function assertType<T>(input: unknown): T;
+
+/**
+ * @internal
+ */
+export function assertType(): never {
+    halt("assertType");
+}
+Object.assign(assertType, Namespace.assert("assertType"));
+
+/**
+ * Tests a value type.
+ *
+ * Tests a parametric value type and returns whether it's following the type `T` or not.
+ * If the parametric value is matched with the type `T`, `true` value would be returned.
+ * Otherwise, the parametric value is not following the type `T`, `false` value would be
+ * returned.
+ *
+ * If what you want is not just knowing whether the parametric value is following the
+ * type `T` or not, but throwing an exception with detailed reason, you can choose
+ * {@link assert} function instead. Also, if you want to know all the errors with
+ * detailed reasons, {@link validate} function would be useful.
+ *
+ * On the other and, if you don't want to allow any superfluous property that is not
+ * enrolled to the type `T`, you can use {@link equals} function instead.
+ *
+ * @template T Type of the input value
+ * @param input A value to be tested
+ * @returns Whether the parametric value is following the type `T` or not
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export function is<T>(input: T): input is T;
+
+/**
+ * Tests a value type.
+ *
+ * Tests a parametric value type and returns whether it's following the type `T` or not.
+ * If the parametric value is matched with the type `T`, `true` value would be returned.
+ * Otherwise, the parametric value is not following the type `T`, `false` value would be
+ * returned.
+ *
+ * If what you want is not just knowing whether the parametric value is following the
+ * type `T` or not, but throwing an exception with detailed reason, you can choose
+ * {@link assert} function instead. Also, if you want to know all the errors with
+ * detailed reasons, {@link validate} function would be useful.
+ *
+ * On the other and, if you don't want to allow any superfluous property that is not
+ * enrolled to the type `T`, you can use {@link equals} function instead.
+ *
+ * @template T Type of the input value
+ * @param input A value to be tested
+ * @returns Whether the parametric value is following the type `T` or not
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export function is<T>(input: unknown): input is T;
+
+/**
+ * @internal
+ */
+export function is(): never {
+    halt("is");
+}
+Object.assign(is, Namespace.assert("is"));
+
+/**
+ * Validates a value type.
+ *
+ * Validates a parametric value type and archives all the type errors into an
+ * {@link IValidation.errors} array, if the parametric value is not following the
+ * type `T`. Of course, if the parametric value is following the type `T`, the
+ * {@link IValidation.errors} array would be empty and {@link IValidation.success}
+ * would have the `true` value.
+ *
+ * If what you want is not finding all the error, but asserting the parametric value
+ * type with exception throwing, you can choose {@link assert} function instead.
+ * Otherwise, you just want to know whether the parametric value is matched with the
+ * type `T`, {@link is} function is the way to go.
+ *
+ * On the other and, if you don't want to allow any superfluous property that is not
+ * enrolled to the type `T`, you can use {@link validateEquals} function instead.
+ *
+ * @template Type of the input value
+ * @param input A value to be validated
+ * @returns Validation result
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export function validate<T>(input: T): IValidation<T>;
+
+/**
+ * Validates a value type.
+ *
+ * Validates a parametric value type and archives all the type errors into an
+ * {@link IValidation.errors} array, if the parametric value is not following the
+ * type `T`. Of course, if the parametric value is following the type `T`, the
+ * {@link IValidation.errors} array would be empty and {@link IValidation.success}
+ * would have the `true` value.
+ *
+ * If what you want is not finding all the error, but asserting the parametric value
+ * type with exception throwing, you can choose {@link assert} function instead.
+ * Otherwise, you just want to know whether the parametric value is matched with the
+ * type `T`, {@link is} function is the way to go.
+ *
+ * On the other and, if you don't want to allow any superfluous property that is not
+ * enrolled to the type `T`, you can use {@link validateEquals} function instead.
+ *
+ * @template Type of the input value
+ * @param input A value to be validated
+ * @returns Validation result
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export function validate<T>(input: unknown): IValidation<T>;
+
+/**
+ * @internal
+ */
+export function validate(): never {
+    halt("validate");
+}
+Object.assign(validate, Namespace.validate());
+
+/* -----------------------------------------------------------
+    STRICT VALIDATORS
+----------------------------------------------------------- */
+/**
+ * Asserts equality between a value and its type.
+ *
+ * Asserts a parametric value type and throws a {@link TypeGuardError} with detailed
+ * reason, if the parametric value is not following the type `T` or some superfluous
+ * property that is not listed on the type `T` has been found. Otherwise, the value is
+ * following the type `T` without any superfluous property, just input parameter would
+ * be returned.
+ *
+ * If what you want is not asserting but just knowing whether the parametric value is
+ * following the type `T` or not, you can choose the {@link equals} function instead.
+ * Otherwise, you want to know all the errors, {@link validateEquals} is the way to go.
+ *
+ * On the other hand, if you want to allow superfluous property that is not enrolled
+ * to the type `T`, you can use {@link assert} function instead.
+ *
+ * @template T Type of the input value
+ * @param input A value to be asserted
+ * @returns Parametric input value
+ * @throws A {@link TypeGuardError} instance with detailed reason
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export function assertEquals<T>(input: T): T;
+
+/**
+ * Asserts equality between a value and its type.
+ *
+ * Asserts a parametric value type and throws a {@link TypeGuardError} with detailed
+ * reason, if the parametric value is not following the type `T` or some superfluous
+ * property that is not listed on the type `T` has been found. Otherwise, the value is
+ * following the type `T` without any superfluous property, just input parameter would
+ * be returned.
+ *
+ * If what you want is not asserting but just knowing whether the parametric value is
+ * following the type `T` or not, you can choose the {@link equals} function instead.
+ * Otherwise, you want to know all the errors, {@link validateEquals} is the way to go.
+ *
+ * On the other hand, if you want to allow superfluous property that is not enrolled
+ * to the type `T`, you can use {@link assert} function instead.
+ *
+ * @template T Type of the input value
+ * @param input A value to be asserted
+ * @returns Parametric input value casted as `T`
+ * @throws A {@link TypeGuardError} instance with detailed reason
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export function assertEquals<T>(input: unknown): T;
+
+/**
+ * @internal
+ */
+export function assertEquals(): never {
+    halt("assertEquals");
+}
+Object.assign(assertEquals, Namespace.assert("assertEquals"));
+
+/**
+ * Tests equality between a value and its type.
+ *
+ * Tests a parametric value type and returns whether it's equivalent to the type `T`
+ * or not. If the parametric value is matched with the type `T` and there's not any
+ * superfluous property that is not listed on the type `T`, `true` value would be
+ * returned. Otherwise, the parametric value is not following the type `T` or some
+ * superfluous property exists, `false` value would be returned.
+ *
+ * If what you want is not just knowing whether the parametric value is following the
+ * type `T` or not, but throwing an exception with detailed reason, you can choose
+ * {@link assertEquals} function instead. Also, if you want to know all the errors with
+ * detailed reasons, {@link validateEquals} function would be useful.
+ *
+ * On the other hand, if you want to allow superfluous property that is not enrolled
+ * to the type `T`, you can use {@link is} function instead.
+ *
+ * @template T Type of the input value
+ * @param input A value to be tested
+ * @returns Whether the parametric value is equivalent to the type `T` or not
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export function equals<T>(input: T): input is T;
+
+/**
+ * Tests equality between a value and its type.
+ *
+ * Tests a parametric value type and returns whether it's equivalent to the type `T`
+ * or not. If the parametric value is matched with the type `T` and there's not any
+ * superfluous property that is not listed on the type `T`, `true` value would be
+ * returned. Otherwise, the parametric value is not following the type `T` or some
+ * superfluous property exists, `false` value would be returned.
+ *
+ * If what you want is not just knowing whether the parametric value is following the
+ * type `T` or not, but throwing an exception with detailed reason, you can choose
+ * {@link assertEquals} function instead. Also, if you want to know all the errors with
+ * detailed reasons, {@link validateEquals} function would be useful.
+ *
+ * On the other hand, if you want to allow superfluous property that is not enrolled
+ * to the type `T`, you can use {@link is} function instead.
+ *
+ * @template T Type of the input value
+ * @param input A value to be tested
+ * @returns Whether the parametric value is equivalent to the type `T` or not
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export function equals<T>(input: unknown): input is T;
+
+/**
+ * @internal
+ */
+export function equals(): never {
+    halt("equals");
+}
+Object.assign(equals, Namespace.is());
+
+/**
+ * Validates equality between a value and its type.
+ *
+ * Validates a parametric value type and archives all the type errors into an
+ * {@link IValidation.errors} array, if the parametric value is not following the
+ * type `T` or some superfluous property that is not listed on the type `T` has been
+ * found. Of course, if the parametric value is following the type `T` and no
+ * superfluous property exists, the {@link IValidation.errors} array would be empty
+ * and {@link IValidation.success} would have the `true` value.
+ *
+ * If what you want is not finding all the error, but asserting the parametric value
+ * type with exception throwing, you can choose {@link assert} function instead.
+ * Otherwise, you just want to know whether the parametric value is matched with the
+ * type `T`, {@link is} function is the way to go.
+ *
+ * On the other and, if you don't want to allow any superfluous property that is not
+ * enrolled to the type `T`, you can use {@link validateEquals} function instead.
+ *
+ * @template Type of the input value
+ * @param input A value to be validated
+ * @returns Validation result
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export function validateEquals<T>(input: T): IValidation<T>;
+
+/**
+ * Validates equality between a value and its type.
+ *
+ * Validates a parametric value type and archives all the type errors into an
+ * {@link IValidation.errors} array, if the parametric value is not following the
+ * type `T` or some superfluous property that is not listed on the type `T` has been
+ * found. Of course, if the parametric value is following the type `T` and no
+ * superfluous property exists, the {@link IValidation.errors} array would be empty
+ * and {@link IValidation.success} would have the `true` value.
+ *
+ * If what you want is not finding all the error, but asserting the parametric value
+ * type with exception throwing, you can choose {@link assert} function instead.
+ * Otherwise, you just want to know whether the parametric value is matched with the
+ * type `T`, {@link is} function is the way to go.
+ *
+ * On the other and, if you don't want to allow any superfluous property that is not
+ * enrolled to the type `T`, you can use {@link validateEquals} function instead.
+ *
+ * @template Type of the input value
+ * @param input A value to be validated
+ * @returns Validation result
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export function validateEquals<T>(input: unknown): IValidation<T>;
+
+/**
+ * @internal
+ */
+export function validateEquals(): never {
+    halt("validateEquals");
+}
+Object.assign(validateEquals, Namespace.validate());
+
+/* -----------------------------------------------------------
+    RANDOM
+----------------------------------------------------------- */
+/**
+ * > You must configure the generic argument `T`.
+ *
+ * Generate random data.
+ *
+ * Generates a random data following type the `T`.
+ *
+ * For reference, this `typia.random()` function generates only primitive type.
+ * If there're some methods in the type `T` or its nested instances, those would
+ * be ignored. Also, when the type `T` has a `toJSON()` method, its return type
+ * would be generated instead.
+ *
+ * @template T Type of data to generate
+ * @param generator Random data generator
+ * @return Randomly generated data
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export function random(generator?: Partial<IRandomGenerator>): never;
+
+/**
+ * Generate random data.
+ *
+ * Generates a random data following type the `T`.
+ *
+ * For reference, this `typia.random()` function generates only primitive type.
+ * If there're some methods in the type `T` or its nested instances, those would
+ * be ignored. Also, when the type `T` has a `toJSON()` method, its return type
+ * would be generated instead.
+ *
+ * @template T Type of data to generate
+ * @param generator Random data generator
+ * @return Randomly generated data
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export function random<T>(generator?: Partial<IRandomGenerator>): Primitive<T>;
+
+/**
+ * @internal
+ */
+export function random(): never {
+    halt("random");
+}
+Object.assign(random, Namespace.random());
+
+/**
+ * @internal
+ */
+export function metadata(): never;
+
+/**
+ * @internal
+ */
+export function metadata<Types extends unknown[]>(): IMetadataApplication;
+
+/**
+ * @internal
+ */
+export function metadata(): never {
+    halt("metadata");
+}
+
+/* -----------------------------------------------------------
+    FACTORY FUNCTIONS
+----------------------------------------------------------- */
+/**
+ * Creates a reusable {@link assert} function.
+ *
+ * @danger You have to specify the generic argument `T`
+ * @return Nothing until specifying the generic argument `T`
+ * @throws compile error
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export function createAssert(): never;
+
+/**
+ * Creates a reusable {@link assert} function.
+ *
+ * @template T Type of the input value
+ * @returns A reusable `assert` function
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export function createAssert<T>(): (input: unknown) => T;
+
+/**
+ * @internal
+ */
+export function createAssert<T>(): (input: unknown) => T {
+    halt("createAssert");
+}
+Object.assign(createAssert, assert);
+
+/**
+ * Creates a reusable {@link assertType} function.
+ *
+ * Duplicated function of {@link createAssert} for `typescript-is` users.
+ *
+ * @danger You have to specify the generic argument `T`
+ * @return Nothing until specifying the generic argument `T`
+ * @throws compile error
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ * @deprecated
+ */
+export function createAssertType(): never;
+
+/**
+ * Creates a reusable {@link assertType} function.
+ *
+ * Duplicated function of {@link createAssert} for `typescript-is` users.
+ *
+ * @template T Type of the input value
+ * @returns A reusable `assert` function
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ * @deprecated
+ */
+export function createAssertType<T>(): (input: unknown) => T;
+
+/**
+ * @internal
+ */
+export function createAssertType<T>(): (input: unknown) => T {
+    halt("createAssertType");
+}
+Object.assign(createAssertType, assertType);
+
+/**
+ * Creates a reusable {@link is} function.
+ *
+ * @danger You have to specify the generic argument `T`
+ * @return Nothing until specifying the generic argument `T`
+ * @throws compile error
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export function createIs(): never;
+
+/**
+ * Creates a reusable {@link is} function.
+ *
+ * @template T Type of the input value
+ * @returns A reusable `is` function
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export function createIs<T>(): (input: unknown) => input is T;
+
+/**
+ * @internal
+ */
+export function createIs<T>(): (input: unknown) => input is T {
+    halt("createIs");
+}
+Object.assign(createIs, is);
+
+/**
+ * Creates a reusable {@link validate} function.
+ *
+ * @danger You have to specify the generic argument `T`
+ * @return Nothing until specifying the generic argument `T`
+ * @throws compile error
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export function createValidate(): never;
+
+/**
+ * Creates a reusable {@link validate} function.
+ *
+ * @template T Type of the input value
+ * @returns A reusable `validate` function
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export function createValidate<T>(): (input: unknown) => IValidation<T>;
+
+/**
+ * @internal
+ */
+export function createValidate(): (input: unknown) => IValidation {
+    halt("createValidate");
+}
+Object.assign(createValidate, validate);
+
+/**
+ * Creates a reusable {@link assertEquals} function.
+ *
+ * @danger You have to specify the generic argument `T`
+ * @return Nothing until specifying the generic argument `T`
+ * @throws compile error
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export function createAssertEquals(): never;
+
+/**
+ * Creates a reusable {@link assertEquals} function.
+ *
+ * @template T Type of the input value
+ * @returns A reusable `assertEquals` function
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export function createAssertEquals<T>(): (input: unknown) => T;
+
+/**
+ * @internal
+ */
+export function createAssertEquals<T>(): (input: unknown) => T {
+    halt("createAssertEquals");
+}
+Object.assign(createAssertEquals, assertEquals);
+
+/**
+ * Creates a reusable {@link equals} function.
+ *
+ * @danger You have to specify the generic argument `T`
+ * @return Nothing until specifying the generic argument `T`
+ * @throws compile error
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export function createEquals(): never;
+
+/**
+ * Creates a reusable {@link equals} function.
+ *
+ * @template T Type of the input value
+ * @returns A reusable `equals` function
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export function createEquals<T>(): (input: unknown) => input is T;
+
+/**
+ * @internal
+ */
+export function createEquals<T>(): (input: unknown) => input is T {
+    halt("createEquals");
+}
+Object.assign(createEquals, equals);
+
+/**
+ * Creates a reusable {@link validateEquals} function.
+ *
+ * @danger You have to specify the generic argument `T`
+ * @return Nothing until specifying the generic argument `T`
+ * @throws compile error
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export function createValidateEquals(): never;
+
+/**
+ * Creates a reusable {@link validateEquals} function.
+ *
+ * @template T Type of the input value
+ * @returns A reusable `validateEquals` function
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export function createValidateEquals<T>(): (input: unknown) => IValidation<T>;
+
+/**
+ * @internal
+ */
+export function createValidateEquals(): (input: unknown) => IValidation {
+    halt("createValidateEquals");
+}
+Object.assign(createValidateEquals, validateEquals);
+
+/**
+ * Creates a reusable {@link random} function.
+ *
+ * @danger You have to specify the generic argument `T`
+ * @param generator Random data generator
+ * @return Nothing until specifying the generic argument `T`
+ * @throws compile error
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export function createRandom(generator?: Partial<IRandomGenerator>): never;
+
+/**
+ * Creates a resuable {@link random} function.
+ *
+ * @template T Type of the input value
+ * @param generator Random data generator
+ * @returns A reusable `random` function
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export function createRandom<T>(
+    generator?: Partial<IRandomGenerator>,
+): () => Primitive<T>;
+
+/**
+ * @internal
+ */
+export function createRandom(): never {
+    halt("createRandom");
+}
+Object.assign(createRandom, random);
+
+/**
+ * @internal
+ */
+function halt(name: string): never {
+    throw new Error(
+        `Error on typia.${name}(): no transform has been configured. Read and follow https://typia.io/docs/setup please.`,
+    );
+}