typia 5.5.0-dev.20240304 → 5.5.0-dev.20240306

package/lib/functional.d.ts

@@ -1,3 +1,4 @@
+import { IValidation } from "./IValidation";
 import { TypeGuardError } from "./TypeGuardError";
 /**
  * Asserts a function.
@@ -195,3 +196,331 @@ export { assertEqualsParametersPure as assertEqualsParameters };
 declare function assertEqualsReturn<T extends (...args: any[]) => any>(func: T, errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): T;
 declare const assertEqualsReturnPure: typeof assertEqualsReturn;
 export { assertEqualsReturnPure as assertEqualsReturn };
+/**
+ * Tests a function.
+ *
+ * Tests a function, by wrapping the function and checking its parameters and
+ * return value through {@link is} function. If some parameter or return value
+ * does not match the expected type, it returns `null`. Otherwise there's no
+ * type error, it returns the result of the function.
+ *
+ * By the way, if you want is not just testing type checking, but also finding
+ * detailed type error reason(s), then use {@link assertFunction} or
+ * {@link validateFunction} instead.
+ *
+ * On the other hand, if you don't want to allow any superfluous properties,
+ * utilize {@link equalsFunction}, {@link assertEqualsFunction} or
+ * {@link validateEqualsFunction} instead.
+ *
+ * @template T Target function type
+ * @param func Target function to test
+ * @returns The wrapper function with type tests
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+declare function isFunction<T extends (...args: any[]) => any>(func: T): T extends (...args: infer Arguments) => infer Output ? Output extends Promise<infer R> ? (...args: Arguments) => Promise<R | null> : (...args: Arguments) => Output | null : never;
+declare const isFunctionPure: typeof isFunction;
+export { isFunctionPure as isFunction };
+/**
+ * Tests parameters.
+ *
+ * Tests a function, by wrapping the function and checking its parameters through
+ * {@link is} function. If some parameter does not match the expected type, it
+ * returns `null`. Otherwise there's no type error, it returns the result of the
+ * function.
+ *
+ * By the way, if you want is not just testing type checking, but also finding
+ * detailed type error reason(s), then use {@link assertParameters} or
+ * {@link validateParameters} instead.
+ *
+ * On the other hand, if you don't want to allow any superfluous properties,
+ * utilize {@link equalsParameters}, {@link assertEqualsParameters} or
+ * {@link validateEqualsParameters} instead.
+ *
+ * @template T Target function type
+ * @param func Target function to test
+ * @returns The wrapper function with type tests
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+declare function isParameters<T extends (...args: any[]) => any>(func: T): T extends (...args: infer Arguments) => infer Output ? Output extends Promise<infer R> ? (...args: Arguments) => Promise<R | null> : (...args: Arguments) => Output | null : never;
+declare const isParametersPure: typeof isParameters;
+export { isParametersPure as isParameters };
+/**
+ * Tests return value.
+ *
+ * Tests a function, by wrapping the function and checking its return value through
+ * {@link is} function. If the return value does not match the expected type, it
+ * returns `null`. Otherwise there's no type error, it returns the result of the
+ * function.
+ *
+ * By the way, if you want is not just testing type checking, but also finding
+ * detailed type error reason(s), then use {@link assertReturn} or
+ * {@link validateReturn} instead.
+ *
+ * On the other hand, if you don't want to allow any superfluous properties,
+ * utilize {@link equalsReturn}, {@link assertEqualsReturn} or
+ * {@link validateEqualsReturn} instead.
+ *
+ * @template T Target function type
+ * @param func Target function to test
+ * @returns The wrapper function with type tests
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+declare function isReturn<T extends (...args: any[]) => any>(func: T): T extends (...args: infer Arguments) => infer Output ? Output extends Promise<infer R> ? (...args: Arguments) => Promise<R | null> : (...args: Arguments) => Output | null : never;
+declare const isReturnPure: typeof isReturn;
+export { isReturnPure as isReturn };
+/**
+ * Tests a function with strict equality.
+ *
+ * Tests a function with strict equality, by wrapping the function and checking its
+ * parameters and return value through {@link isEquals} function. If some parameter
+ * or return value does not match the expected type, it returns `null`. Otherwise
+ * there's no type error, it returns the result of the function.
+ *
+ * By the way, if you want is not just testing type checking, but also finding
+ * detailed type error reason(s), then use {@link assertEqualsFunction} or
+ * {@link validateEqualsFunction} instead.
+ *
+ * On the other hand, if you want to allow any superfluous properties, utilize
+ * {@link isFunction}, {@link assertFunction} or {@link validateFunction} instead.
+ *
+ * @template T Target function type
+ * @param func Target function to test
+ * @returns The wrapper function with type tests
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+declare function equalsFunction<T extends (...args: any[]) => any>(func: T): T extends (...args: infer Arguments) => infer Output ? Output extends Promise<infer R> ? (...args: Arguments) => Promise<R | null> : (...args: Arguments) => Output | null : never;
+declare const equalsFunctionPure: typeof equalsFunction;
+export { equalsFunctionPure as equalsFunction };
+/**
+ * Tests parameters with strict equality.
+ *
+ * Tests a function, by wrapping the function and checking its parameters through
+ * {@link isEquals} function. If some parameter does not match the expected type,
+ * it returns `null`. Otherwise there's no type error, it returns the result of the
+ * function.
+ *
+ * By the way, if you want is not just testing type checking, but also finding
+ * detailed type error reason(s), then use {@link assertEqualsParameters} or
+ * {@link validateEqualsParameters} instead.
+ *
+ * @template T Target function type
+ * @param func Target function to test
+ * @returns The wrapper function with type tests
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+declare function equalsParameters<T extends (...args: any[]) => any>(func: T): T extends (...args: infer Arguments) => infer Output ? Output extends Promise<infer R> ? (...args: Arguments) => Promise<R | null> : (...args: Arguments) => Output | null : never;
+declare const equalsParametersPure: typeof equalsParameters;
+export { equalsParametersPure as equalsParameters };
+/**
+ * Tests return value with strict equality.
+ *
+ * Tests a function, by wrapping the function and checking its return value through
+ * {@link isEquals} function. If the return value does not match the expected type,
+ * it returns `null`. Otherwise there's no type error, it returns the result of the
+ * function.
+ *
+ * By the way, if you want is not just testing type checking, but also finding
+ * detailed type error reason(s), then use {@link assertEqualsReturn} or
+ * {@link validateEqualsReturn} instead.
+ *
+ * On the other hand, if you want to allow any superfluous properties, utilize
+ * {@link isReturn}, {@link assertReturn} or {@link validateReturn} instead.
+ *
+ * @template T Target function type
+ * @param func Target function to test
+ * @returns The wrapper function with type tests
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+declare function equalsReturn<T extends (...args: any[]) => any>(func: T): T extends (...args: infer Arguments) => infer Output ? Output extends Promise<infer R> ? (...args: Arguments) => Promise<R | null> : (...args: Arguments) => Output | null : never;
+declare const equalsReturnPure: typeof equalsReturn;
+export { equalsReturnPure as equalsReturn };
+/**
+ * Validates a function.
+ *
+ * Validates a function, by wrapping the function and checking its parameters and
+ * return value through {@link validate} function. If some parameter or return value
+ * does not match the expected type, it returns {@link IValidation.IError} typed
+ * object. Otherwise there's no type error, it returns {@link IValidation.ISuccess}
+ * typed object instead.
+ *
+ * For reference, {@link IValidation.IError.path} would be a little bit different with
+ * individual {@link validate} function. If the {@link IValidation.IError} occurs from
+ * some parameter, the path would start from `$input.parameters[number]`. Otherwise
+ * the path would start from `$input.return`.
+ *
+ * - `$input.parameters[0].~`
+ * - `$input.return.~`
+ *
+ * By the way, if what you want is not finding every type errors, but just finding
+ * the 1st type error, then use {@link assertFunction} instead. Otherwise, what you
+ * want is just validating parameters or return value only, you can use
+ * {@link validateParameters} or {@link validateReturn} instead.
+ *
+ * On the other hand, if you don't want to allow any superfluous properties, utilize
+ * {@link validateEqualsFunction} or {@link assertEqualsFunction} instead.
+ *
+ * @template T Target function type
+ * @param func Target function to validate
+ * @returns The wrapper function with type validations
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+declare function validateFunction<T extends (...args: any[]) => any>(func: T): T extends (...args: infer Arguments) => infer Output ? Output extends Promise<infer R> ? (...args: Arguments) => Promise<IValidation<R>> : (...args: Arguments) => IValidation<Output> : never;
+declare const validateFunctionPure: typeof validateFunction;
+export { validateFunctionPure as validateFunction };
+/**
+ * Validates parameters.
+ *
+ * Validates a function, by wrapping the function and checking its parameters through
+ * {@link validate} function. If some parameter does not match the expected type, it
+ * returns {@link IValidation.IError} typed object. Otherwise there's no type error,
+ * it returns {@link IValidation.ISuccess} typed object instead.
+ *
+ * For reference, {@link IValidation.IError.path} would be a little bit different with
+ * individual {@link validate} function. If the {@link IValidation.IError} occurs from
+ * some parameter, the path would start from `$input.parameters[number]`.
+ *
+ * By the way, if what you want is not finding every type errors, but just finding
+ * the 1st type error, then use {@link assertParameters} instead. Otherwise, what you
+ * want is not only validating parameters, but also validating return value, you can
+ * use {@link validateFunction} instead.
+ *
+ * On the other hand, if you don't want to allow any superfluous properties, utilize
+ * {@link validateEqualsParameters} or {@link assertEqualsParameters} instead.
+ *
+ * @template T Target function type
+ * @param func Target function to validate
+ * @returns The wrapper function with type validations
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+declare function validateParameters<T extends (...args: any[]) => any>(func: T): T extends (...args: infer Arguments) => infer Output ? Output extends Promise<infer R> ? (...args: Arguments) => Promise<IValidation<R>> : (...args: Arguments) => IValidation<Output> : never;
+declare const validateParametersPure: typeof validateParameters;
+export { validateParametersPure as validateParameters };
+/**
+ * Validates return value.
+ *
+ * Validates a function, by wrapping the function and checking its return value through
+ * {@link validate} function. If the return value does not match the expected type, it
+ * returns {@link IValidation.IError} typed object. Otherwise there's no type error,
+ * it returns {@link IValidation.ISuccess} typed object instead.
+ *
+ * For reference, {@link IValidation.IError.path} would be a little bit different with
+ * individual {@link validate} function. If the {@link IValidation.IError} occurs from
+ * the return value, the path would start from `$input.return`.
+ *
+ * By the way, if what you want is not finding every type errors, but just finding
+ * the 1st type error, then use {@link assertReturn} instead. Otherwise, what you want
+ * is not only validating return value, but also validating parameters, you can use
+ * {@link validateFunction} instead.
+ *
+ * On the other hand, if you don't want to allow any superfluous properties, utilize
+ * {@link validateEqualsReturn} or {@link assertEqualsReturn} instead.
+ *
+ * @template T Target function type
+ * @param func Target function to validate
+ * @returns The wrapper function with type validations
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+declare function validateReturn<T extends (...args: any[]) => any>(func: T): T extends (...args: infer Arguments) => infer Output ? Output extends Promise<infer R> ? (...args: Arguments) => Promise<IValidation<R>> : (...args: Arguments) => IValidation<Output> : never;
+declare const validateReturnPure: typeof validateReturn;
+export { validateReturnPure as validateReturn };
+/**
+ * Validates a function with strict equality.
+ *
+ * Validates a function with strict equality, by wrapping the function and checking
+ * its parameters and return value through {@link validateEquals} function. If some
+ * parameter or return value does not match the expected type, it returns
+ * {@link IValidation.IError} typed object. Otherwise there's no type error, it
+ * returns {@link IValidation.ISuccess} typed object instead.
+ *
+ * For reference, {@link IValidation.IError.path} would be a little bit different with
+ * individual {@link validateEquals} function. If the {@link IValidation.IError} occurs
+ * from some parameter, the path would start from `$input.parameters[number]`. Otherwise
+ * the path would start from `$input.return`.
+ *
+ * - `$input.parameters[0].~`
+ * - `$input.return.~`
+ *
+ * By the way, if what you want is not finding every type errors, but just finding
+ * the 1st type error, then use {@link assertEqualsFunction} instead. Otherwise, what
+ * you want is just validating parameters or return value only, you can use
+ * {@link validateEqualsParameters} or {@link validateEqualsReturn} instead.
+ *
+ * On the other hand, if you want to allow any superfluous properties, utilize
+ * {@link validateFunction} or {@link assertFunction} instead.
+ *
+ * @template T Target function type
+ * @param func Target function to validate
+ * @returns The wrapper function with type validations
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+declare function validateEqualsFunction<T extends (...args: any[]) => any>(func: T): T extends (...args: infer Arguments) => infer Output ? Output extends Promise<infer R> ? (...args: Arguments) => Promise<IValidation<R>> : (...args: Arguments) => IValidation<Output> : never;
+declare const validateEqualsFunctionPure: typeof validateEqualsFunction;
+export { validateEqualsFunctionPure as validateEqualsFunction };
+/**
+ * Validates parameters with strict equality.
+ *
+ * Validates a function, by wrapping the function and checking its parameters through
+ * {@link validateEquals} function. If some parameter does not match the expected type,
+ * it returns {@link IValidation.IError} typed object. Otherwise there's no type error,
+ * it returns {@link IValidation.ISuccess} typed object instead.
+ *
+ * For reference, {@link IValidation.IError.path} would be a little bit different with
+ * individual {@link validateEquals} function. If the {@link IValidation.IError} occurs
+ * from some parameter, the path would start from `$input.parameters[number]`.
+ *
+ * By the way, if what you want is not finding every type errors, but just finding
+ * the 1st type error, then use {@link assertEqualsParameters} instead. Otherwise,
+ * what you want is not only validating parameters, but also validating return value,
+ * you can use {@link validateEqualsFunction} instead.
+ *
+ * On the other hand, if you want to allow any superfluous properties, utilize
+ * {@link validateParameters} or {@link assertParameters} instead.
+ *
+ * @template T Target function type
+ * @param func Target function to validate
+ * @returns The wrapper function with type validations
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+declare function validateEqualsParameters<T extends (...args: any[]) => any>(func: T): T extends (...args: infer Arguments) => infer Output ? Output extends Promise<infer R> ? (...args: Arguments) => Promise<IValidation<R>> : (...args: Arguments) => IValidation<Output> : never;
+declare const validateEqualsParametersPure: typeof validateEqualsParameters;
+export { validateEqualsParametersPure as validateEqualsParameters };
+/**
+ * Validates return value with strict equality.
+ *
+ * Validates a function, by wrapping the function and checking its return value through
+ * {@link validateEquals} function. If the return value does not match the expected type,
+ * it returns {@link IValidation.IError} typed object. Otherwise there's no type error,
+ * it returns {@link IValidation.ISuccess} typed object instead.
+ *
+ * For reference, {@link IValidation.IError.path} would be a little bit different with
+ * individual {@link validateEquals} function. If the {@link IValidation.IError} occurs
+ * from the return value, the path would start from `$input.return`.
+ *
+ * By the way, if what you want is not finding every type errors, but just finding
+ * the 1st type error, then use {@link assertEqualsReturn} instead. Otherwise, what you
+ * want is not only validating return value, but also validating parameters, you can use
+ * {@link validateEqualsFunction} instead.
+ *
+ * On the other hand, if you want to allow any superfluous properties, utilize
+ * {@link validateReturn} or {@link assertReturn} instead.
+ *
+ * @template T Target function type
+ * @param func Target function to validate
+ * @returns The wrapper function with type validations
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+declare function validateEqualsReturn<T extends (...args: any[]) => any>(func: T): T extends (...args: infer Arguments) => infer Output ? Output extends Promise<infer R> ? (...args: Arguments) => Promise<IValidation<R>> : (...args: Arguments) => IValidation<Output> : never;
+declare const validateEqualsReturnPure: typeof validateEqualsReturn;
+export { validateEqualsReturnPure as validateEqualsReturn };