typia 6.0.0-dev.20240122 → 6.0.0

package/lib/notations.d.ts

@@ -2,6 +2,7 @@ import { CamelCase } from "./CamelCase";
 import { IValidation } from "./IValidation";
 import { PascalCase } from "./PascalCase";
 import { SnakeCase } from "./SnakeCase";
+import { TypeGuardError } from "./TypeGuardError";
 /**
  * Convert to camel case.
  *
@@ -21,7 +22,9 @@ import { SnakeCase } from "./SnakeCase";
  *
  * @author Jeongho Nam - https://github.com/samchon
  */
-export declare function camel<T>(input: T): CamelCase<T>;
+declare function camel<T>(input: T): CamelCase<T>;
+declare const camelPure: typeof camel;
+export { camelPure as camel };
 /**
  * Converts to camel case with type assertion.
  *
@@ -30,11 +33,12 @@ export declare function camel<T>(input: T): CamelCase<T>;
  *
  * @template T Type of the input value
  * @param input Target object
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
  * @returns Camel case object
  *
  * @author Jeongho Nam - https://github.com/samchon
  */
-export declare function assertCamel<T>(input: T): CamelCase<T>;
+declare function assertCamel<T>(input: T, errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): CamelCase<T>;
 /**
  * Converts to camel case with type assertion.
  *
@@ -43,11 +47,14 @@ export declare function assertCamel<T>(input: T): CamelCase<T>;
  *
  * @template T Type of the input value
  * @param input Target object
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
  * @returns Camel case object
  *
  * @author Jeongho Nam - https://github.com/samchon
  */
-export declare function assertCamel<T>(input: unknown): CamelCase<T>;
+declare function assertCamel<T>(input: unknown, errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): CamelCase<T>;
+declare const assertCamelPure: typeof assertCamel;
+export { assertCamelPure as assertCamel };
 /**
  * Converts to camel case with type checking.
  *
@@ -60,7 +67,7 @@ export declare function assertCamel<T>(input: unknown): CamelCase<T>;
  *
  * @author Jeongho Nam - https://github.com/samchon
  */
-export declare function isCamel<T>(input: T): CamelCase<T> | null;
+declare function isCamel<T>(input: T): CamelCase<T> | null;
 /**
  * Converts to camel case with type checking.
  *
@@ -73,7 +80,9 @@ export declare function isCamel<T>(input: T): CamelCase<T> | null;
  *
  * @author Jeongho Nam - https://github.com/samchon
  */
-export declare function isCamel<T>(input: unknown): CamelCase<T> | null;
+declare function isCamel<T>(input: unknown): CamelCase<T> | null;
+declare const isCamelPure: typeof isCamel;
+export { isCamelPure as isCamel };
 /**
  * Converts to camel case with type validation.
  *
@@ -88,7 +97,7 @@ export declare function isCamel<T>(input: unknown): CamelCase<T> | null;
  *
  * @author Jeongho Nam - https://github.com/samchon
  */
-export declare function validateCamel<T>(input: T): IValidation<CamelCase<T>>;
+declare function validateCamel<T>(input: T): IValidation<CamelCase<T>>;
 /**
  * Converts to camel case with type validation.
  *
@@ -103,7 +112,9 @@ export declare function validateCamel<T>(input: T): IValidation<CamelCase<T>>;
  *
  * @author Jeongho Nam - https://github.com/samchon
  */
-export declare function validateCamel<T>(input: unknown): IValidation<CamelCase<T>>;
+declare function validateCamel<T>(input: unknown): IValidation<CamelCase<T>>;
+declare const validateCamelPure: typeof validateCamel;
+export { validateCamelPure as validateCamel };
 /**
  * Convert to pascal case.
  *
@@ -123,7 +134,9 @@ export declare function validateCamel<T>(input: unknown): IValidation<CamelCase<
  *
  * @author Jeongho Nam - https://github.com/samchon
  */
-export declare function pascal<T>(input: T): PascalCase<T>;
+declare function pascal<T>(input: T): PascalCase<T>;
+declare const pascalPure: typeof pascal;
+export { pascalPure as pascal };
 /**
  * Converts to pascal case with type assertion.
  *
@@ -132,11 +145,12 @@ export declare function pascal<T>(input: T): PascalCase<T>;
  *
  * @template T Type of the input value
  * @param input Target object
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
  * @returns Pascal case object
  *
  * @author Jeongho Nam - https://github.com/samchon
  */
-export declare function assertPascal<T>(input: T): PascalCase<T>;
+declare function assertPascal<T>(input: T, errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): PascalCase<T>;
 /**
  * Converts to pascal case with type assertion.
  *
@@ -145,11 +159,14 @@ export declare function assertPascal<T>(input: T): PascalCase<T>;
  *
  * @template T Type of the input value
  * @param input Target object
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
  * @returns Pascal case object
  *
  * @author Jeongho Nam - https://github.com/samchon
  */
-export declare function assertPascal<T>(input: unknown): PascalCase<T>;
+declare function assertPascal<T>(input: unknown, errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): PascalCase<T>;
+declare const assertPascalPure: typeof assertPascal;
+export { assertPascalPure as assertPascal };
 /**
  * Converts to pascal case with type checking.
  *
@@ -162,7 +179,7 @@ export declare function assertPascal<T>(input: unknown): PascalCase<T>;
  *
  * @author Jeongho Nam - https://github.com/samchon
  */
-export declare function isPascal<T>(input: T): PascalCase<T> | null;
+declare function isPascal<T>(input: T): PascalCase<T> | null;
 /**
  * Converts to pascal case with type checking.
  *
@@ -175,7 +192,9 @@ export declare function isPascal<T>(input: T): PascalCase<T> | null;
  *
  * @author Jeongho Nam - https://github.com/samchon
  */
-export declare function isPascal<T>(input: unknown): PascalCase<T> | null;
+declare function isPascal<T>(input: unknown): PascalCase<T> | null;
+declare const isPascalPure: typeof isPascal;
+export { isPascalPure as isPascal };
 /**
  * Converts to pascal case with type validation.
  *
@@ -190,7 +209,7 @@ export declare function isPascal<T>(input: unknown): PascalCase<T> | null;
  *
  * @author Jeongho Nam - https://github.com/samchon
  */
-export declare function validatePascal<T>(input: T): IValidation<PascalCase<T>>;
+declare function validatePascal<T>(input: T): IValidation<PascalCase<T>>;
 /**
  * Converts to pascal case with type validation.
  *
@@ -205,7 +224,9 @@ export declare function validatePascal<T>(input: T): IValidation<PascalCase<T>>;
  *
  * @author Jeongho Nam - https://github.com/samchon
  */
-export declare function validatePascal<T>(input: unknown): IValidation<PascalCase<T>>;
+declare function validatePascal<T>(input: unknown): IValidation<PascalCase<T>>;
+declare const validatePascalPure: typeof validatePascal;
+export { validatePascalPure as validatePascal };
 /**
  * Convert to snake case.
  *
@@ -225,7 +246,9 @@ export declare function validatePascal<T>(input: unknown): IValidation<PascalCas
  *
  * @author Jeongho Nam - https://github.com/samchon
  */
-export declare function snake<T>(input: T): SnakeCase<T>;
+declare function snake<T>(input: T): SnakeCase<T>;
+declare const snakePure: typeof snake;
+export { snakePure as snake };
 /**
  * Converts to snake case with type assertion.
  *
@@ -234,11 +257,12 @@ export declare function snake<T>(input: T): SnakeCase<T>;
  *
  * @template T Type of the input value
  * @param input Target object
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
  * @returns Snake case object
  *
  * @author Jeongho Nam - https://github.com/samchon
  */
-export declare function assertSnake<T>(input: T): SnakeCase<T>;
+declare function assertSnake<T>(input: T, errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): SnakeCase<T>;
 /**
  * Converts to snake case with type assertion.
  *
@@ -247,11 +271,14 @@ export declare function assertSnake<T>(input: T): SnakeCase<T>;
  *
  * @template T Type of the input value
  * @param input Target object
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
  * @returns Snake case object
  *
  * @author Jeongho Nam - https://github.com/samchon
  */
-export declare function assertSnake<T>(input: unknown): SnakeCase<T>;
+declare function assertSnake<T>(input: unknown, errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): SnakeCase<T>;
+declare const assertSnakePure: typeof assertSnake;
+export { assertSnakePure as assertSnake };
 /**
  * Converts to snake case with type checking.
  *
@@ -264,7 +291,7 @@ export declare function assertSnake<T>(input: unknown): SnakeCase<T>;
  *
  * @author Jeongho Nam - https://github.com/samchon
  */
-export declare function isSnake<T>(input: T): SnakeCase<T> | null;
+declare function isSnake<T>(input: T): SnakeCase<T> | null;
 /**
  * Converts to snake case with type checking.
  *
@@ -277,7 +304,9 @@ export declare function isSnake<T>(input: T): SnakeCase<T> | null;
  *
  * @author Jeongho Nam - https://github.com/samchon
  */
-export declare function isSnake<T>(input: unknown): SnakeCase<T> | null;
+declare function isSnake<T>(input: unknown): SnakeCase<T> | null;
+declare const isSnakePure: typeof isSnake;
+export { isSnakePure as isSnake };
 /**
  * Converts to snake case with type validation.
  *
@@ -292,7 +321,7 @@ export declare function isSnake<T>(input: unknown): SnakeCase<T> | null;
  *
  * @author Jeongho Nam - https://github.com/samchon
  */
-export declare function validateSnake<T>(input: T): IValidation<SnakeCase<T>>;
+declare function validateSnake<T>(input: T): IValidation<SnakeCase<T>>;
 /**
  * Converts to snake case with type validation.
  *
@@ -307,7 +336,9 @@ export declare function validateSnake<T>(input: T): IValidation<SnakeCase<T>>;
  *
  * @author Jeongho Nam - https://github.com/samchon
  */
-export declare function validateSnake<T>(input: unknown): IValidation<SnakeCase<T>>;
+declare function validateSnake<T>(input: unknown): IValidation<SnakeCase<T>>;
+declare const validateSnakePure: typeof validateSnake;
+export { validateSnakePure as validateSnake };
 /**
  * Creates a reusable {@link camel} function.
  *
@@ -317,7 +348,7 @@ export declare function validateSnake<T>(input: unknown): IValidation<SnakeCase<
  *
  * @author Jeongho Nam - https://github.com/samchon
  */
-export declare function createCamel(): never;
+declare function createCamel(): never;
 /**
  * Creates a reusable {@link camel} function.
  *
@@ -326,26 +357,32 @@ export declare function createCamel(): never;
  *
  * @author Jeongho Nam - https://github.com/samchon
  */
-export declare function createCamel<T>(): (input: T) => CamelCase<T>;
+declare function createCamel<T>(): (input: T) => CamelCase<T>;
+declare const createCamelPure: typeof createCamel;
+export { createCamelPure as createCamel };
 /**
  * Creates a reusable {@link assertCamel} function.
  *
  * @danger You must configure the generic argument `T`
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
  * @returns Nothing until be configure the generic argument `T`
  * @throws compile error
  *
  * @author Jeongho Nam - https://github.com/samchon
  */
-export declare function createAssertCamel(): never;
+declare function createAssertCamel(errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): never;
 /**
  * Creates a reusable {@link assertCamel} function.
  *
  * @template T Type of the input value
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
  * @returns A reusable `assertCamel` function
  *
  * @author Jeongho Nam - https://github.com/samchon
  */
-export declare function createAssertCamel<T>(): (input: T) => CamelCase<T>;
+declare function createAssertCamel<T>(errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): (input: T) => CamelCase<T>;
+declare const createAssertCamelPure: typeof createAssertCamel;
+export { createAssertCamelPure as createAssertCamel };
 /**
  * Creates a reusable {@link isCamel} function.
  *
@@ -355,7 +392,7 @@ export declare function createAssertCamel<T>(): (input: T) => CamelCase<T>;
  *
  * @author Jeongho Nam - https://github.com/samchon
  */
-export declare function createIsCamel(): never;
+declare function createIsCamel(): never;
 /**
  * Creates a reusable {@link isCamel} function.
  *
@@ -364,7 +401,9 @@ export declare function createIsCamel(): never;
  *
  * @author Jeongho Nam - https://github.com/samchon
  */
-export declare function createIsCamel<T>(): (input: T) => CamelCase<T> | null;
+declare function createIsCamel<T>(): (input: T) => CamelCase<T> | null;
+declare const createIsCamelPure: typeof createIsCamel;
+export { createIsCamelPure as createIsCamel };
 /**
  * Creates a reusable {@link validateCamel} function.
  *
@@ -374,7 +413,7 @@ export declare function createIsCamel<T>(): (input: T) => CamelCase<T> | null;
  *
  * @author Jeongho Nam - https://github.com/samchon
  */
-export declare function createValidateCamel(): never;
+declare function createValidateCamel(): never;
 /**
  * Creates a reusable {@link validateCamel} function.
  *
@@ -383,7 +422,9 @@ export declare function createValidateCamel(): never;
  *
  * @author Jeongho Nam - https://github.com/samchon
  */
-export declare function createValidateCamel<T>(): (input: T) => IValidation<CamelCase<T>>;
+declare function createValidateCamel<T>(): (input: T) => IValidation<CamelCase<T>>;
+declare const createValidateCamelPure: typeof createValidateCamel;
+export { createValidateCamelPure as createValidateCamel };
 /**
  * Creates a reusable {@link pascal} function.
  *
@@ -393,7 +434,7 @@ export declare function createValidateCamel<T>(): (input: T) => IValidation<Came
  *
  * @author Jeongho Nam - https://github.com/samchon
  */
-export declare function createPascal(): never;
+declare function createPascal(): never;
 /**
  * Creates a reusable {@link pascal} function.
  *
@@ -402,26 +443,32 @@ export declare function createPascal(): never;
  *
  * @author Jeongho Nam - https://github.com/samchon
  */
-export declare function createPascal<T>(): (input: T) => PascalCase<T>;
+declare function createPascal<T>(): (input: T) => PascalCase<T>;
+declare const createPascalPure: typeof createPascal;
+export { createPascalPure as createPascal };
 /**
  * Creates a reusable {@link assertPascal} function.
  *
  * @danger You must configure the generic argument `T`
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
  * @returns Nothing until be configure the generic argument `T`
  * @throws compile error
  *
  * @author Jeongho Nam - https://github.com/samchon
  */
-export declare function createAssertPascal(): never;
+declare function createAssertPascal(errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): never;
 /**
  * Creates a reusable {@link assertPascal} function.
  *
  * @template T Type of the input value
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
  * @returns A reusable `assertPascal` function
  *
  * @author Jeongho Nam - https://github.com/samchon
  */
-export declare function createAssertPascal<T>(): (input: T) => PascalCase<T>;
+declare function createAssertPascal<T>(errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): (input: T) => PascalCase<T>;
+declare const createAssertPascalPure: typeof createAssertPascal;
+export { createAssertPascalPure as createAssertPascal };
 /**
  * Creates a reusable {@link isPascal} function.
  *
@@ -431,7 +478,7 @@ export declare function createAssertPascal<T>(): (input: T) => PascalCase<T>;
  *
  * @author Jeongho Nam - https://github.com/samchon
  */
-export declare function createIsPascal(): never;
+declare function createIsPascal(): never;
 /**
  * Creates a reusable {@link isPascal} function.
  *
@@ -440,7 +487,9 @@ export declare function createIsPascal(): never;
  *
  * @author Jeongho Nam - https://github.com/samchon
  */
-export declare function createIsPascal<T>(): (input: T) => PascalCase<T> | null;
+declare function createIsPascal<T>(): (input: T) => PascalCase<T> | null;
+declare const createIsPascalPure: typeof createIsPascal;
+export { createIsPascalPure as createIsPascal };
 /**
  * Creates a reusable {@link validatePascal} function.
  *
@@ -450,7 +499,7 @@ export declare function createIsPascal<T>(): (input: T) => PascalCase<T> | null;
  *
  * @author Jeongho Nam - https://github.com/samchon
  */
-export declare function createValidatePascal(): never;
+declare function createValidatePascal(): never;
 /**
  * Creates a reusable {@link validatePascal} function.
  *
@@ -459,7 +508,9 @@ export declare function createValidatePascal(): never;
  *
  * @author Jeongho Nam - https://github.com/samchon
  */
-export declare function createValidatePascal<T>(): (input: T) => IValidation<PascalCase<T>>;
+declare function createValidatePascal<T>(): (input: T) => IValidation<PascalCase<T>>;
+declare const createValidatePascalPure: typeof createValidatePascal;
+export { createValidatePascalPure as createValidatePascal };
 /**
  * Creates a reusable {@link snake} function.
  *
@@ -469,7 +520,7 @@ export declare function createValidatePascal<T>(): (input: T) => IValidation<Pas
  *
  * @author Jeongho Nam - https://github.com/samchon
  */
-export declare function createSnake(): never;
+declare function createSnake(): never;
 /**
  * Creates a reusable {@link snake} function.
  *
@@ -478,26 +529,32 @@ export declare function createSnake(): never;
  *
  * @author Jeongho Nam - https://github.com/samchon
  */
-export declare function createSnake<T>(): (input: T) => SnakeCase<T>;
+declare function createSnake<T>(): (input: T) => SnakeCase<T>;
+declare const createSnakePure: typeof createSnake;
+export { createSnakePure as createSnake };
 /**
  * Creates a reusable {@link assertSnake} function.
  *
  * @danger You must configure the generic argument `T`
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
  * @returns Nothing until be configure the generic argument `T`
  * @throws compile error
  *
  * @author Jeongho Nam - https://github.com/samchon
  */
-export declare function createAssertSnake(): never;
+declare function createAssertSnake(errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): never;
 /**
  * Creates a reusable {@link assertSnake} function.
  *
  * @template T Type of the input value
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
  * @returns A reusable `assertSnake` function
  *
  * @author Jeongho Nam - https://github.com/samchon
  */
-export declare function createAssertSnake<T>(): (input: T) => SnakeCase<T>;
+declare function createAssertSnake<T>(errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): (input: T) => SnakeCase<T>;
+declare const createAssertSnakePure: typeof createAssertSnake;
+export { createAssertSnakePure as createAssertSnake };
 /**
  * Creates a reusable {@link isSnake} function.
  *
@@ -507,7 +564,7 @@ export declare function createAssertSnake<T>(): (input: T) => SnakeCase<T>;
  *
  * @author Jeongho Nam - https://github.com/samchon
  */
-export declare function createIsSnake(): never;
+declare function createIsSnake(): never;
 /**
  * Creates a reusable {@link isSnake} function.
  *
@@ -516,7 +573,9 @@ export declare function createIsSnake(): never;
  *
  * @author Jeongho Nam - https://github.com/samchon
  */
-export declare function createIsSnake<T>(): (input: T) => SnakeCase<T> | null;
+declare function createIsSnake<T>(): (input: T) => SnakeCase<T> | null;
+declare const createIsSnakePure: typeof createIsSnake;
+export { createIsSnakePure as createIsSnake };
 /**
  * Creates a reusable {@link validateSnake} function.
  *
@@ -526,7 +585,7 @@ export declare function createIsSnake<T>(): (input: T) => SnakeCase<T> | null;
  *
  * @author Jeongho Nam - https://github.com/samchon
  */
-export declare function createValidateSnake(): never;
+declare function createValidateSnake(): never;
 /**
  * Creates a reusable {@link validateSnake} function.
  *
@@ -535,4 +594,6 @@ export declare function createValidateSnake(): never;
  *
  * @author Jeongho Nam - https://github.com/samchon
  */
-export declare function createValidateSnake<T>(): (input: T) => IValidation<SnakeCase<T>>;
+declare function createValidateSnake<T>(): (input: T) => IValidation<SnakeCase<T>>;
+declare const createValidateSnakePure: typeof createValidateSnake;
+export { createValidateSnakePure as createValidateSnake };