typia 15.0.1 → 15.1.0

package/src/notations.ts

@@ -35,8 +35,11 @@ import { NoTransformConfigurationError } from "./transformers/NoTransformConfigu
  * - {@link validateCamel} — Returns detailed validation errors
  *
  * @template T Type of input value
+ *
  * @param input Object to convert
+ *
  * @returns New object with camelCase property names
+ *
  * @throws {Error} When two source keys become the same destination key
  */
 export function camel<T>(input: T): CamelCase<T>;
@@ -59,10 +62,13 @@ export function camel(): never {
  * - {@link validateCamel} — Returns detailed validation errors
  *
  * @template T Type of input value
+ *
  * @param input Object to convert
  * @param errorFactory Custom error factory receiving
  *   {@link TypeGuardError.IProps}
+ *
  * @returns New object with camelCase property names
+ *
  * @throws {TypeGuardError} When input doesn't conform to type `T`
  */
 export function assertCamel<T>(
@@ -94,7 +100,9 @@ export function assertCamel(): never {
  * - {@link validateCamel} — Returns detailed validation errors
  *
  * @template T Type of input value
+ *
  * @param input Object to convert
+ *
  * @returns New object with camelCase property names, or `null` if invalid
  */
 export function isCamel<T>(input: T): CamelCase<T> | null;
@@ -121,7 +129,9 @@ export function isCamel(): never {
  * - {@link isCamel} — Returns `null` instead of error details
  *
  * @template T Type of input value
+ *
  * @param input Object to convert
+ *
  * @returns Validation result containing converted object or errors
  */
 export function validateCamel<T>(input: T): IValidation<CamelCase<T>>;
@@ -153,8 +163,11 @@ export function validateCamel(): never {
  * - {@link validatePascal} — Returns detailed validation errors
  *
  * @template T Type of input value
+ *
  * @param input Object to convert
+ *
  * @returns New object with PascalCase property names
+ *
  * @throws {Error} When two source keys become the same destination key
  */
 export function pascal<T>(input: T): PascalCase<T>;
@@ -177,10 +190,13 @@ export function pascal(): never {
  * - {@link validatePascal} — Returns detailed validation errors
  *
  * @template T Type of input value
+ *
  * @param input Object to convert
  * @param errorFactory Custom error factory receiving
  *   {@link TypeGuardError.IProps}
+ *
  * @returns New object with PascalCase property names
+ *
  * @throws {TypeGuardError} When input doesn't conform to type `T`
  */
 export function assertPascal<T>(
@@ -212,7 +228,9 @@ export function assertPascal(): never {
  * - {@link validatePascal} — Returns detailed validation errors
  *
  * @template T Type of input value
+ *
  * @param input Object to convert
+ *
  * @returns New object with PascalCase property names, or `null` if invalid
  */
 export function isPascal<T>(input: T): PascalCase<T> | null;
@@ -239,7 +257,9 @@ export function isPascal(): never {
  * - {@link isPascal} — Returns `null` instead of error details
  *
  * @template T Type of input value
+ *
  * @param input Object to convert
+ *
  * @returns Validation result containing converted object or errors
  */
 export function validatePascal<T>(input: T): IValidation<PascalCase<T>>;
@@ -271,8 +291,11 @@ export function validatePascal(): never {
  * - {@link validateSnake} — Returns detailed validation errors
  *
  * @template T Type of input value
+ *
  * @param input Object to convert
+ *
  * @returns New object with snake_case property names
+ *
  * @throws {Error} When two source keys become the same destination key
  */
 export function snake<T>(input: T): SnakeCase<T>;
@@ -295,10 +318,13 @@ export function snake(): never {
  * - {@link validateSnake} — Returns detailed validation errors
  *
  * @template T Type of input value
+ *
  * @param input Object to convert
  * @param errorFactory Custom error factory receiving
  *   {@link TypeGuardError.IProps}
+ *
  * @returns New object with snake_case property names
+ *
  * @throws {TypeGuardError} When input doesn't conform to type `T`
  */
 export function assertSnake<T>(
@@ -330,7 +356,9 @@ export function assertSnake(): never {
  * - {@link validateSnake} — Returns detailed validation errors
  *
  * @template T Type of input value
+ *
  * @param input Object to convert
+ *
  * @returns New object with snake_case property names, or `null` if invalid
  */
 export function isSnake<T>(input: T): SnakeCase<T> | null;
@@ -357,7 +385,9 @@ export function isSnake(): never {
  * - {@link isSnake} — Returns `null` instead of error details
  *
  * @template T Type of input value
+ *
  * @param input Object to convert
+ *
  * @returns Validation result containing converted object or errors
  */
 export function validateSnake<T>(input: T): IValidation<SnakeCase<T>>;
@@ -389,8 +419,11 @@ export function validateSnake(): never {
  * - {@link validateKebab} — Returns detailed validation errors
  *
  * @template T Type of input value
+ *
  * @param input Object to convert
+ *
  * @returns New object with kebab-case property names
+ *
  * @throws {Error} When two source keys become the same destination key
  */
 export function kebab<T>(input: T): KebabCase<T>;
@@ -413,10 +446,13 @@ export function kebab(): never {
  * - {@link validateKebab} — Returns detailed validation errors
  *
  * @template T Type of input value
+ *
  * @param input Object to convert
  * @param errorFactory Custom error factory receiving
  *   {@link TypeGuardError.IProps}
+ *
  * @returns New object with kebab-case property names
+ *
  * @throws {TypeGuardError} When input doesn't conform to type `T`
  */
 export function assertKebab<T>(
@@ -448,7 +484,9 @@ export function assertKebab(): never {
  * - {@link validateKebab} — Returns detailed validation errors
  *
  * @template T Type of input value
+ *
  * @param input Object to convert
+ *
  * @returns New object with kebab-case property names, or `null` if invalid
  */
 export function isKebab<T>(input: T): KebabCase<T> | null;
@@ -475,7 +513,9 @@ export function isKebab(): never {
  * - {@link isKebab} — Returns `null` instead of error details
  *
  * @template T Type of input value
+ *
  * @param input Object to convert
+ *
  * @returns Validation result containing converted object or errors
  */
 export function validateKebab<T>(input: T): IValidation<KebabCase<T>>;
@@ -502,6 +542,7 @@ export function createCamel(): never;
  * Creates reusable {@link camel} function.
  *
  * @template T Type of input value
+ *
  * @returns Reusable conversion function
  */
 export function createCamel<T>(): (input: T) => CamelCase<T>;
@@ -524,8 +565,10 @@ export function createAssertCamel(
  * Creates reusable {@link assertCamel} function.
  *
  * @template T Type of input value
+ *
  * @param errorFactory Custom error factory receiving
  *   {@link TypeGuardError.IProps}
+ *
  * @returns Reusable conversion function
  */
 export function createAssertCamel<T>(
@@ -551,6 +594,7 @@ export function createIsCamel(): never;
  * Creates reusable {@link isCamel} function.
  *
  * @template T Type of input value
+ *
  * @returns Reusable conversion function
  */
 export function createIsCamel<T>(): (input: T) => CamelCase<T> | null;
@@ -571,6 +615,7 @@ export function createValidateCamel(): never;
  * Creates reusable {@link validateCamel} function.
  *
  * @template T Type of input value
+ *
  * @returns Reusable conversion function
  */
 export function createValidateCamel<T>(): (
@@ -593,6 +638,7 @@ export function createPascal(): never;
  * Creates reusable {@link pascal} function.
  *
  * @template T Type of input value
+ *
  * @returns Reusable conversion function
  */
 export function createPascal<T>(): (input: T) => PascalCase<T>;
@@ -615,8 +661,10 @@ export function createAssertPascal(
  * Creates reusable {@link assertPascal} function.
  *
  * @template T Type of input value
+ *
  * @param errorFactory Custom error factory receiving
  *   {@link TypeGuardError.IProps}
+ *
  * @returns Reusable conversion function
  */
 export function createAssertPascal<T>(
@@ -642,6 +690,7 @@ export function createIsPascal(): never;
  * Creates reusable {@link isPascal} function.
  *
  * @template T Type of input value
+ *
  * @returns Reusable conversion function
  */
 export function createIsPascal<T>(): (input: T) => PascalCase<T> | null;
@@ -662,6 +711,7 @@ export function createValidatePascal(): never;
  * Creates reusable {@link validatePascal} function.
  *
  * @template T Type of input value
+ *
  * @returns Reusable conversion function
  */
 export function createValidatePascal<T>(): (
@@ -684,6 +734,7 @@ export function createSnake(): never;
  * Creates reusable {@link snake} function.
  *
  * @template T Type of input value
+ *
  * @returns Reusable conversion function
  */
 export function createSnake<T>(): (input: T) => SnakeCase<T>;
@@ -706,8 +757,10 @@ export function createAssertSnake(
  * Creates reusable {@link assertSnake} function.
  *
  * @template T Type of input value
+ *
  * @param errorFactory Custom error factory receiving
  *   {@link TypeGuardError.IProps}
+ *
  * @returns Reusable conversion function
  */
 export function createAssertSnake<T>(
@@ -733,6 +786,7 @@ export function createIsSnake(): never;
  * Creates reusable {@link isSnake} function.
  *
  * @template T Type of input value
+ *
  * @returns Reusable conversion function
  */
 export function createIsSnake<T>(): (input: T) => SnakeCase<T> | null;
@@ -753,6 +807,7 @@ export function createValidateSnake(): never;
  * Creates reusable {@link validateSnake} function.
  *
  * @template T Type of input value
+ *
  * @returns Reusable conversion function
  */
 export function createValidateSnake<T>(): (
@@ -775,6 +830,7 @@ export function createKebab(): never;
  * Creates reusable {@link kebab} function.
  *
  * @template T Type of input value
+ *
  * @returns Reusable conversion function
  */
 export function createKebab<T>(): (input: T) => KebabCase<T>;
@@ -797,8 +853,10 @@ export function createAssertKebab(
  * Creates reusable {@link assertKebab} function.
  *
  * @template T Type of input value
+ *
  * @param errorFactory Custom error factory receiving
  *   {@link TypeGuardError.IProps}
+ *
  * @returns Reusable conversion function
  */
 export function createAssertKebab<T>(
@@ -824,6 +882,7 @@ export function createIsKebab(): never;
  * Creates reusable {@link isKebab} function.
  *
  * @template T Type of input value
+ *
  * @returns Reusable conversion function
  */
 export function createIsKebab<T>(): (input: T) => KebabCase<T> | null;
@@ -844,6 +903,7 @@ export function createValidateKebab(): never;
  * Creates reusable {@link validateKebab} function.
  *
  * @template T Type of input value
+ *
  * @returns Reusable conversion function
  */
 export function createValidateKebab<T>(): (

package/src/plain.ts

@@ -31,7 +31,9 @@ import { NoTransformConfigurationError } from "./transformers/NoTransformConfigu
  * - {@link validateClone} — Returns detailed validation errors
  *
  * @template T Type of input value
+ *
  * @param input Value to clone
+ *
  * @returns Deep cloned value
  */
 export function clone<T>(input: T): Resolved<T>;
@@ -55,10 +57,13 @@ export function clone(): never {
  * - {@link validateClone} — Returns detailed validation errors
  *
  * @template T Type of input value
+ *
  * @param input Value to clone
  * @param errorFactory Custom error factory receiving
  *   {@link TypeGuardError.IProps}
+ *
  * @returns Deep cloned value
+ *
  * @throws {TypeGuardError} When input doesn't conform to type `T`
  */
 export function assertClone<T>(
@@ -90,7 +95,9 @@ export function assertClone(): never {
  * - {@link validateClone} — Returns detailed validation errors
  *
  * @template T Type of input value
+ *
  * @param input Value to clone
+ *
  * @returns Deep cloned value, or `null` if invalid
  */
 export function isClone<T>(input: T): Resolved<T> | null;
@@ -118,7 +125,9 @@ export function isClone(): never {
  * - {@link isClone} — Returns `null` instead of error details
  *
  * @template T Type of input value
+ *
  * @param input Value to clone
+ *
  * @returns Validation result containing cloned value or errors
  */
 export function validateClone<T>(input: T): IValidation<Resolved<T>>;
@@ -147,6 +156,7 @@ export function validateClone(): never {
  * - {@link validatePrune} — Returns detailed validation errors
  *
  * @template T Type of input value
+ *
  * @param input Object to prune
  */
 export function prune<T extends object>(input: T): void;
@@ -170,10 +180,13 @@ export function prune(): never {
  * - {@link validatePrune} — Returns detailed validation errors
  *
  * @template T Type of input value
+ *
  * @param input Object to assert and prune
  * @param errorFactory Custom error factory receiving
  *   {@link TypeGuardError.IProps}
+ *
  * @returns The pruned input
+ *
  * @throws {TypeGuardError} When input doesn't conform to type `T`
  */
 export function assertPrune<T>(
@@ -206,7 +219,9 @@ export function assertPrune(): unknown {
  * - {@link validatePrune} — Returns detailed validation errors
  *
  * @template T Type of input value
+ *
  * @param input Object to check and prune
+ *
  * @returns `true` if valid and pruned, `false` if type mismatch
  */
 export function isPrune<T>(input: T): input is T;
@@ -234,7 +249,9 @@ export function isPrune(): never {
  * - {@link isPrune} — Returns `false` instead of error details
  *
  * @template T Type of input value
+ *
  * @param input Object to validate and prune
+ *
  * @returns Validation result
  */
 export function validatePrune<T>(input: T): IValidation<T>;
@@ -266,7 +283,9 @@ export function validatePrune<T>(): IValidation<T> {
  * - {@link validateClassify} — Returns detailed validation errors
  *
  * @template T Target class type to reconstruct
+ *
  * @param input Plain data to classify
+ *
  * @returns A real instance of type `T`
  */
 export function classify<T>(input: Classifiable<T>): ClassifyResult<T>;
@@ -289,10 +308,13 @@ export function classify(): never {
  * - {@link validateClassify} — Returns detailed validation errors
  *
  * @template T Target class type to reconstruct
+ *
  * @param input Plain data to validate and classify
  * @param errorFactory Custom error factory receiving
  *   {@link TypeGuardError.IProps}
+ *
  * @returns A real instance of type `T`
+ *
  * @throws {TypeGuardError} When input doesn't conform to type `T`
  */
 export function assertClassify<T>(
@@ -324,7 +346,9 @@ export function assertClassify(): never {
  * - {@link assertClassify} — Throws on first error
  *
  * @template T Target class type to reconstruct
+ *
  * @param input Plain data to validate and classify
+ *
  * @returns Validation result containing the instance or errors
  */
 export function validateClassify<T>(
@@ -355,6 +379,7 @@ export function createClone(): never;
  * Creates reusable {@link clone} function.
  *
  * @template T Type of input value
+ *
  * @returns Reusable clone function
  */
 export function createClone<T>(): (input: T) => Resolved<T>;
@@ -377,8 +402,10 @@ export function createAssertClone(
  * Creates reusable {@link assertClone} function.
  *
  * @template T Type of input value
+ *
  * @param errorFactory Custom error factory receiving
  *   {@link TypeGuardError.IProps}
+ *
  * @returns Reusable clone function
  */
 export function createAssertClone<T>(
@@ -404,6 +431,7 @@ export function createIsClone(): never;
  * Creates reusable {@link isClone} function.
  *
  * @template T Type of input value
+ *
  * @returns Reusable clone function
  */
 export function createIsClone<T>(): (input: unknown) => Resolved<T> | null;
@@ -424,6 +452,7 @@ export function createValidateClone(): never;
  * Creates reusable {@link validateClone} function.
  *
  * @template T Type of input value
+ *
  * @returns Reusable clone function
  */
 export function createValidateClone<T>(): (
@@ -446,6 +475,7 @@ export function createPrune(): never;
  * Creates reusable {@link prune} function.
  *
  * @template T Type of input value
+ *
  * @returns Reusable prune function
  */
 export function createPrune<T extends object>(): (input: T) => void;
@@ -468,8 +498,10 @@ export function createAssertPrune(
  * Creates reusable {@link assertPrune} function.
  *
  * @template T Type of input value
+ *
  * @param errorFactory Custom error factory receiving
  *   {@link TypeGuardError.IProps}
+ *
  * @returns Reusable prune function
  */
 export function createAssertPrune<T extends object>(
@@ -495,6 +527,7 @@ export function createIsPrune(): never;
  * Creates reusable {@link isPrune} function.
  *
  * @template T Type of input value
+ *
  * @returns Reusable prune function
  */
 export function createIsPrune<T extends object>(): (
@@ -517,6 +550,7 @@ export function createValidatePrune(): never;
  * Creates reusable {@link validatePrune} function.
  *
  * @template T Type of input value
+ *
  * @returns Reusable prune function
  */
 export function createValidatePrune<T extends object>(): (
@@ -539,6 +573,7 @@ export function createClassify(): never;
  * Creates reusable {@link classify} function.
  *
  * @template T Target class type to reconstruct
+ *
  * @returns Reusable classify function
  */
 export function createClassify<T>(): (
@@ -563,8 +598,10 @@ export function createAssertClassify(
  * Creates reusable {@link assertClassify} function.
  *
  * @template T Target class type to reconstruct
+ *
  * @param errorFactory Custom error factory receiving
  *   {@link TypeGuardError.IProps}
+ *
  * @returns Reusable classify function
  */
 export function createAssertClassify<T>(
@@ -590,6 +627,7 @@ export function createValidateClassify(): never;
  * Creates reusable {@link validateClassify} function.
  *
  * @template T Target class type to reconstruct
+ *
  * @returns Reusable classify function
  */
 export function createValidateClassify<T>(): (