typia 4.2.2 → 4.2.3

package/src/transformers/CallExpressionTransformer.ts

@@ -1,179 +1,179 @@
-import path from "path";
-import ts from "typescript";
-
-import { IProject } from "./IProject";
-import { ApplicationTransformer } from "./features/miscellaneous/ApplicationTransformer";
-import { AssertCloneTransformer } from "./features/miscellaneous/AssertCloneTransformer";
-import { AssertPruneTransformer } from "./features/miscellaneous/AssertPruneTransformer";
-import { CloneTransformer } from "./features/miscellaneous/CloneTransformer";
-import { CreateAssertCloneTransformer } from "./features/miscellaneous/CreateAssertCloneTransformer";
-import { CreateAssertPruneTransformer } from "./features/miscellaneous/CreateAssertPruneTransformer";
-import { CreateCloneTransformer } from "./features/miscellaneous/CreateCloneTransformer";
-import { CreateIsCloneTransformer } from "./features/miscellaneous/CreateIsCloneTransformer";
-import { CreateIsPruneTransformer } from "./features/miscellaneous/CreateIsPruneTransformer";
-import { CreatePruneTransformer } from "./features/miscellaneous/CreatePruneTransformer";
-import { CreateRandomTransformer } from "./features/miscellaneous/CreateRandomTransformer";
-import { CreateValidateCloneTransformer } from "./features/miscellaneous/CreateValidateCloneTransformer";
-import { CreateValidatePruneTransformer } from "./features/miscellaneous/CreateValidatePruneTransformer";
-import { IsCloneTransformer } from "./features/miscellaneous/IsCloneTransformer";
-import { IsPruneTransformer } from "./features/miscellaneous/IsPruneTransformer";
-import { LiteralsTransformer } from "./features/miscellaneous/LiteralsTransformer";
-import { MetadataTransformer } from "./features/miscellaneous/MetadataTransformer";
-import { PruneTransformer } from "./features/miscellaneous/PruneTransformer";
-import { RandomTransformer } from "./features/miscellaneous/RandomTransformer";
-import { ValidateCloneTransformer } from "./features/miscellaneous/ValidateCloneTransformer";
-import { ValidatePruneTransformer } from "./features/miscellaneous/ValidatePruneTransformer";
-import { AssertParseTransformer } from "./features/parsers/AssertParseTransformer";
-import { CreateAssertParseTransformer } from "./features/parsers/CreateAssertParseTransformer";
-import { CreateIsParseTransformer } from "./features/parsers/CreateIsParseTransformer";
-import { CreateValidateParseTransformer } from "./features/parsers/CreateValidateParseTransformer";
-import { IsParseTransformer } from "./features/parsers/IsParseTransformer";
-import { ValidateParseTransformer } from "./features/parsers/ValidateParseTransformer";
-import { AssertStringifyTransformer } from "./features/stringifiers/AssertStringifyTransformer";
-import { CreateAssertStringifyTransformer } from "./features/stringifiers/CreateAssertStringifyTransformer";
-import { CreateIsStringifyTransformer } from "./features/stringifiers/CreateIsStringifyTransformer";
-import { CreateStringifyTransformer } from "./features/stringifiers/CreateStringifyTransformer";
-import { CreateValidateStringifyTransformer } from "./features/stringifiers/CreateValidateStringifyProgrammer";
-import { IsStringifyTransformer } from "./features/stringifiers/IsStringifyTransformer";
-import { StringifyTransformer } from "./features/stringifiers/StringifyTransformer";
-import { ValidateStringifyTransformer } from "./features/stringifiers/ValidateStringifyTransformer";
-import { AssertTransformer } from "./features/validators/AssertTransformer";
-import { CreateAssertTransformer } from "./features/validators/CreateAssertTransformer";
-import { CreateIsTransformer } from "./features/validators/CreateIsTransformer";
-import { CreateValidateTransformer } from "./features/validators/CreateValidateTransformer";
-import { IsTransformer } from "./features/validators/IsTransformer";
-import { ValidateTransformer } from "./features/validators/ValidateTransformer";
-
-export namespace CallExpressionTransformer {
-    export const transform =
-        (project: IProject) =>
-        (expression: ts.CallExpression): ts.Expression => {
-            //----
-            // VALIDATIONS
-            //----
-            // SIGNATURE DECLARATION
-            const declaration: ts.Declaration | undefined =
-                project.checker.getResolvedSignature(expression)?.declaration;
-            if (!declaration) return expression;
-
-            // FILE PATH
-            const file: string = path.resolve(
-                declaration.getSourceFile().fileName,
-            );
-            if (
-                file.indexOf(LIB_PATH) === -1 &&
-                file !== SRC_PATH &&
-                file !== CLI_PATH
-            )
-                return expression;
-
-            //----
-            // TRANSFORMATION
-            //----
-            // FUNCTION NAME
-            const { name } =
-                project.checker.getTypeAtLocation(declaration).symbol;
-
-            // FIND TRANSFORMER
-            const functor: (() => Task) | undefined = FUNCTORS[name];
-            if (functor === undefined) return expression;
-
-            // console.log(expression.getSourceFile().fileName);
-
-            // RETURNS WITH TRANSFORMATION
-            return functor()(project)(expression.expression)(expression);
-        };
-}
-
-type Task = (
-    project: IProject,
-) => (
-    modulo: ts.LeftHandSideExpression,
-) => (expression: ts.CallExpression) => ts.Expression;
-
-const LIB_PATH = path.join("node_modules", "typia", "lib", "module.d.ts");
-const SRC_PATH = path.resolve(path.join(__dirname, "..", "module.ts"));
-const CLI_PATH = path.resolve(
-    path.join(__dirname, "..", "..", "..", "src", "module.ts"),
-);
-
-const FUNCTORS: Record<string, () => Task> = {
-    //----
-    // SINGLE FUNCTIONS
-    //----
-    // BASIC VALIDATORS
-    assert: () => AssertTransformer.transform(false),
-    assertType: () => AssertTransformer.transform(false),
-    is: () => IsTransformer.transform(false),
-    validate: () => ValidateTransformer.transform(false),
-
-    // STRICT VALIDATORS
-    assertEquals: () => AssertTransformer.transform(true),
-    equals: () => IsTransformer.transform(true),
-    validateEquals: () => ValidateTransformer.transform(true),
-
-    // PARSE FUNCTIONS
-    isParse: () => IsParseTransformer.transform,
-    assertParse: () => AssertParseTransformer.transform,
-    validateParse: () => ValidateParseTransformer.transform,
-
-    // STRINGIFY FUNCTIONS
-    application: () => (project) => () =>
-        ApplicationTransformer.transform(project),
-    stringify: () => StringifyTransformer.transform,
-    assertStringify: () => AssertStringifyTransformer.transform,
-    isStringify: () => IsStringifyTransformer.transform,
-    validateStringify: () => ValidateStringifyTransformer.transform,
-
-    // MISC
-    metadata: () => (project) => () => MetadataTransformer.transform(project),
-    random: () => RandomTransformer.transform,
-    literals: () => (project) => () => LiteralsTransformer.transform(project),
-
-    clone: () => CloneTransformer.transform,
-    assertClone: () => AssertCloneTransformer.transform,
-    isClone: () => IsCloneTransformer.transform,
-    validateClone: () => ValidateCloneTransformer.transform,
-
-    prune: () => PruneTransformer.transform,
-    assertPrune: () => AssertPruneTransformer.transform,
-    isPrune: () => IsPruneTransformer.transform,
-    validatePrune: () => ValidatePruneTransformer.transform,
-
-    //----
-    // FACTORY FUNCTIONS
-    //----
-    // BASIC VALIDATORS
-    createAssert: () => CreateAssertTransformer.transform(false),
-    createAssertType: () => CreateAssertTransformer.transform(false),
-    createIs: () => CreateIsTransformer.transform(false),
-    createValidate: () => CreateValidateTransformer.transform(false),
-
-    // STRICT VALIDATORS
-    createAssertEquals: () => CreateAssertTransformer.transform(true),
-    createEquals: () => CreateIsTransformer.transform(true),
-    createValidateEquals: () => CreateValidateTransformer.transform(true),
-
-    // PARSE FUNCTIONS
-    createIsParse: () => CreateIsParseTransformer.transform,
-    createAssertParse: () => CreateAssertParseTransformer.transform,
-    createValidateParse: () => CreateValidateParseTransformer.transform,
-
-    // STRINGIFY FUNCTIONS
-    createStringify: () => CreateStringifyTransformer.transform,
-    createAssertStringify: () => CreateAssertStringifyTransformer.transform,
-    createIsStringify: () => CreateIsStringifyTransformer.transform,
-    createValidateStringify: () => CreateValidateStringifyTransformer.transform,
-
-    // MISC
-    createRandom: () => CreateRandomTransformer.transform,
-    createClone: () => CreateCloneTransformer.transform,
-    createAssertClone: () => CreateAssertCloneTransformer.transform,
-    createIsClone: () => CreateIsCloneTransformer.transform,
-    createValidateClone: () => CreateValidateCloneTransformer.transform,
-
-    createPrune: () => CreatePruneTransformer.transform,
-    createAssertPrune: () => CreateAssertPruneTransformer.transform,
-    createIsPrune: () => CreateIsPruneTransformer.transform,
-    createValidatePrune: () => CreateValidatePruneTransformer.transform,
-};
+import path from "path";
+import ts from "typescript";
+
+import { IProject } from "./IProject";
+import { ApplicationTransformer } from "./features/miscellaneous/ApplicationTransformer";
+import { AssertCloneTransformer } from "./features/miscellaneous/AssertCloneTransformer";
+import { AssertPruneTransformer } from "./features/miscellaneous/AssertPruneTransformer";
+import { CloneTransformer } from "./features/miscellaneous/CloneTransformer";
+import { CreateAssertCloneTransformer } from "./features/miscellaneous/CreateAssertCloneTransformer";
+import { CreateAssertPruneTransformer } from "./features/miscellaneous/CreateAssertPruneTransformer";
+import { CreateCloneTransformer } from "./features/miscellaneous/CreateCloneTransformer";
+import { CreateIsCloneTransformer } from "./features/miscellaneous/CreateIsCloneTransformer";
+import { CreateIsPruneTransformer } from "./features/miscellaneous/CreateIsPruneTransformer";
+import { CreatePruneTransformer } from "./features/miscellaneous/CreatePruneTransformer";
+import { CreateRandomTransformer } from "./features/miscellaneous/CreateRandomTransformer";
+import { CreateValidateCloneTransformer } from "./features/miscellaneous/CreateValidateCloneTransformer";
+import { CreateValidatePruneTransformer } from "./features/miscellaneous/CreateValidatePruneTransformer";
+import { IsCloneTransformer } from "./features/miscellaneous/IsCloneTransformer";
+import { IsPruneTransformer } from "./features/miscellaneous/IsPruneTransformer";
+import { LiteralsTransformer } from "./features/miscellaneous/LiteralsTransformer";
+import { MetadataTransformer } from "./features/miscellaneous/MetadataTransformer";
+import { PruneTransformer } from "./features/miscellaneous/PruneTransformer";
+import { RandomTransformer } from "./features/miscellaneous/RandomTransformer";
+import { ValidateCloneTransformer } from "./features/miscellaneous/ValidateCloneTransformer";
+import { ValidatePruneTransformer } from "./features/miscellaneous/ValidatePruneTransformer";
+import { AssertParseTransformer } from "./features/parsers/AssertParseTransformer";
+import { CreateAssertParseTransformer } from "./features/parsers/CreateAssertParseTransformer";
+import { CreateIsParseTransformer } from "./features/parsers/CreateIsParseTransformer";
+import { CreateValidateParseTransformer } from "./features/parsers/CreateValidateParseTransformer";
+import { IsParseTransformer } from "./features/parsers/IsParseTransformer";
+import { ValidateParseTransformer } from "./features/parsers/ValidateParseTransformer";
+import { AssertStringifyTransformer } from "./features/stringifiers/AssertStringifyTransformer";
+import { CreateAssertStringifyTransformer } from "./features/stringifiers/CreateAssertStringifyTransformer";
+import { CreateIsStringifyTransformer } from "./features/stringifiers/CreateIsStringifyTransformer";
+import { CreateStringifyTransformer } from "./features/stringifiers/CreateStringifyTransformer";
+import { CreateValidateStringifyTransformer } from "./features/stringifiers/CreateValidateStringifyProgrammer";
+import { IsStringifyTransformer } from "./features/stringifiers/IsStringifyTransformer";
+import { StringifyTransformer } from "./features/stringifiers/StringifyTransformer";
+import { ValidateStringifyTransformer } from "./features/stringifiers/ValidateStringifyTransformer";
+import { AssertTransformer } from "./features/validators/AssertTransformer";
+import { CreateAssertTransformer } from "./features/validators/CreateAssertTransformer";
+import { CreateIsTransformer } from "./features/validators/CreateIsTransformer";
+import { CreateValidateTransformer } from "./features/validators/CreateValidateTransformer";
+import { IsTransformer } from "./features/validators/IsTransformer";
+import { ValidateTransformer } from "./features/validators/ValidateTransformer";
+
+export namespace CallExpressionTransformer {
+    export const transform =
+        (project: IProject) =>
+        (expression: ts.CallExpression): ts.Expression => {
+            //----
+            // VALIDATIONS
+            //----
+            // SIGNATURE DECLARATION
+            const declaration: ts.Declaration | undefined =
+                project.checker.getResolvedSignature(expression)?.declaration;
+            if (!declaration) return expression;
+
+            // FILE PATH
+            const file: string = path.resolve(
+                declaration.getSourceFile().fileName,
+            );
+            if (
+                file.indexOf(LIB_PATH) === -1 &&
+                file !== SRC_PATH &&
+                file !== CLI_PATH
+            )
+                return expression;
+
+            //----
+            // TRANSFORMATION
+            //----
+            // FUNCTION NAME
+            const { name } =
+                project.checker.getTypeAtLocation(declaration).symbol;
+
+            // FIND TRANSFORMER
+            const functor: (() => Task) | undefined = FUNCTORS[name];
+            if (functor === undefined) return expression;
+
+            // console.log(expression.getSourceFile().fileName);
+
+            // RETURNS WITH TRANSFORMATION
+            return functor()(project)(expression.expression)(expression);
+        };
+}
+
+type Task = (
+    project: IProject,
+) => (
+    modulo: ts.LeftHandSideExpression,
+) => (expression: ts.CallExpression) => ts.Expression;
+
+const LIB_PATH = path.join("node_modules", "typia", "lib", "module.d.ts");
+const SRC_PATH = path.resolve(path.join(__dirname, "..", "module.ts"));
+const CLI_PATH = path.resolve(
+    path.join(__dirname, "..", "..", "..", "src", "module.ts"),
+);
+
+const FUNCTORS: Record<string, () => Task> = {
+    //----
+    // SINGLE FUNCTIONS
+    //----
+    // BASIC VALIDATORS
+    assert: () => AssertTransformer.transform(false),
+    assertType: () => AssertTransformer.transform(false),
+    is: () => IsTransformer.transform(false),
+    validate: () => ValidateTransformer.transform(false),
+
+    // STRICT VALIDATORS
+    assertEquals: () => AssertTransformer.transform(true),
+    equals: () => IsTransformer.transform(true),
+    validateEquals: () => ValidateTransformer.transform(true),
+
+    // PARSE FUNCTIONS
+    isParse: () => IsParseTransformer.transform,
+    assertParse: () => AssertParseTransformer.transform,
+    validateParse: () => ValidateParseTransformer.transform,
+
+    // STRINGIFY FUNCTIONS
+    application: () => (project) => () =>
+        ApplicationTransformer.transform(project),
+    stringify: () => StringifyTransformer.transform,
+    assertStringify: () => AssertStringifyTransformer.transform,
+    isStringify: () => IsStringifyTransformer.transform,
+    validateStringify: () => ValidateStringifyTransformer.transform,
+
+    // MISC
+    metadata: () => (project) => () => MetadataTransformer.transform(project),
+    random: () => RandomTransformer.transform,
+    literals: () => (project) => () => LiteralsTransformer.transform(project),
+
+    clone: () => CloneTransformer.transform,
+    assertClone: () => AssertCloneTransformer.transform,
+    isClone: () => IsCloneTransformer.transform,
+    validateClone: () => ValidateCloneTransformer.transform,
+
+    prune: () => PruneTransformer.transform,
+    assertPrune: () => AssertPruneTransformer.transform,
+    isPrune: () => IsPruneTransformer.transform,
+    validatePrune: () => ValidatePruneTransformer.transform,
+
+    //----
+    // FACTORY FUNCTIONS
+    //----
+    // BASIC VALIDATORS
+    createAssert: () => CreateAssertTransformer.transform(false),
+    createAssertType: () => CreateAssertTransformer.transform(false),
+    createIs: () => CreateIsTransformer.transform(false),
+    createValidate: () => CreateValidateTransformer.transform(false),
+
+    // STRICT VALIDATORS
+    createAssertEquals: () => CreateAssertTransformer.transform(true),
+    createEquals: () => CreateIsTransformer.transform(true),
+    createValidateEquals: () => CreateValidateTransformer.transform(true),
+
+    // PARSE FUNCTIONS
+    createIsParse: () => CreateIsParseTransformer.transform,
+    createAssertParse: () => CreateAssertParseTransformer.transform,
+    createValidateParse: () => CreateValidateParseTransformer.transform,
+
+    // STRINGIFY FUNCTIONS
+    createStringify: () => CreateStringifyTransformer.transform,
+    createAssertStringify: () => CreateAssertStringifyTransformer.transform,
+    createIsStringify: () => CreateIsStringifyTransformer.transform,
+    createValidateStringify: () => CreateValidateStringifyTransformer.transform,
+
+    // MISC
+    createRandom: () => CreateRandomTransformer.transform,
+    createClone: () => CreateCloneTransformer.transform,
+    createAssertClone: () => CreateAssertCloneTransformer.transform,
+    createIsClone: () => CreateIsCloneTransformer.transform,
+    createValidateClone: () => CreateValidateCloneTransformer.transform,
+
+    createPrune: () => CreatePruneTransformer.transform,
+    createAssertPrune: () => CreateAssertPruneTransformer.transform,
+    createIsPrune: () => CreateIsPruneTransformer.transform,
+    createValidatePrune: () => CreateValidatePruneTransformer.transform,
+};

package/src/transformers/FileTransformer.ts

@@ -1,47 +1,47 @@
-import ts from "typescript";
-
-import { IProject } from "./IProject";
-import { NodeTransformer } from "./NodeTransformer";
-
-export namespace FileTransformer {
-    export const transform =
-        (project: IProject) =>
-        (context: ts.TransformationContext) =>
-        (file: ts.SourceFile): ts.SourceFile => {
-            if (file.isDeclarationFile) return file;
-            return ts.visitEachChild(
-                file,
-                (node) => iterate_node(project)(context)(node),
-                context,
-            );
-        };
-
-    const iterate_node =
-        (project: IProject) =>
-        (context: ts.TransformationContext) =>
-        (node: ts.Node): ts.Node =>
-            ts.visitEachChild(
-                try_transform_node(project)(node),
-                (child) => iterate_node(project)(context)(child),
-                context,
-            );
-
-    const try_transform_node =
-        (project: IProject) =>
-        (node: ts.Node): ts.Node => {
-            try {
-                return NodeTransformer.transform(project)(node);
-            } catch (exp) {
-                if (!(exp instanceof Error)) throw exp;
-
-                const file: ts.SourceFile = node.getSourceFile();
-                const { line, character } = file.getLineAndCharacterOfPosition(
-                    node.pos,
-                );
-                exp.message += ` - ${file.fileName}:${line + 1}:${
-                    character + 1
-                }`;
-                throw exp;
-            }
-        };
-}
+import ts from "typescript";
+
+import { IProject } from "./IProject";
+import { NodeTransformer } from "./NodeTransformer";
+
+export namespace FileTransformer {
+    export const transform =
+        (project: IProject) =>
+        (context: ts.TransformationContext) =>
+        (file: ts.SourceFile): ts.SourceFile => {
+            if (file.isDeclarationFile) return file;
+            return ts.visitEachChild(
+                file,
+                (node) => iterate_node(project)(context)(node),
+                context,
+            );
+        };
+
+    const iterate_node =
+        (project: IProject) =>
+        (context: ts.TransformationContext) =>
+        (node: ts.Node): ts.Node =>
+            ts.visitEachChild(
+                try_transform_node(project)(node),
+                (child) => iterate_node(project)(context)(child),
+                context,
+            );
+
+    const try_transform_node =
+        (project: IProject) =>
+        (node: ts.Node): ts.Node => {
+            try {
+                return NodeTransformer.transform(project)(node);
+            } catch (exp) {
+                if (!(exp instanceof Error)) throw exp;
+
+                const file: ts.SourceFile = node.getSourceFile();
+                const { line, character } = file.getLineAndCharacterOfPosition(
+                    node.pos,
+                );
+                exp.message += ` - ${file.fileName}:${line + 1}:${
+                    character + 1
+                }`;
+                throw exp;
+            }
+        };
+}

package/src/transformers/IProject.ts

@@ -1,11 +1,11 @@
-import ts from "typescript";
-
-import { ITransformOptions } from "./ITransformOptions";
-
-export interface IProject {
-    program: ts.Program;
-    compilerOptions: ts.CompilerOptions;
-    checker: ts.TypeChecker;
-    printer: ts.Printer;
-    options: ITransformOptions;
-}
+import ts from "typescript";
+
+import { ITransformOptions } from "./ITransformOptions";
+
+export interface IProject {
+    program: ts.Program;
+    compilerOptions: ts.CompilerOptions;
+    checker: ts.TypeChecker;
+    printer: ts.Printer;
+    options: ITransformOptions;
+}

package/src/transformers/ITransformOptions.ts

@@ -1,62 +1,62 @@
-export interface ITransformOptions {
-    /**
-     * Whether to validate finite number or not.
-     *
-     * If configured true, number typed values would be validated by Number.isNaN().
-     *
-     * However, whatever you configure, it would be ignored when marshaling or parsing.
-     *
-     *   - when marshaling, always be true
-     *     - assertStringify()
-     *     - validateEncode()
-     *   - when parsing, always be false
-     *     - assertParse()
-     *     - isDecode()
-     *
-     * @default false
-     */
-    finite?: boolean;
-
-    /**
-     * Whether to validate finite number or not.
-     *
-     * If configured true, number typed values would be validated by Number.isFinite().
-     *
-     * However, whatever you configure, it can be ignored in below case.
-     *
-     *   - when `finite` option is true, this option would be ignored
-     *   - when marshaling, always be true
-     *     - assertStringify()
-     *     - validateEncode()
-     *   - when parsing, always be false
-     *     - assertParse()
-     *     - isDecode()
-     *
-     * @default false
-     */
-    numeric?: boolean;
-
-    /**
-     * Whether to validate functional type or not.
-     *
-     * However, whatever you configure, it becomes false when marshaling or parsing.
-     *
-     * @default false
-     */
-    functional?: boolean;
-
-    /**
-     * Whether to check undefined value or not.
-     *
-     * JavaScript can assign `undefined` value to a specific property and it is an
-     * issue when validating without allowing superfluous properties. Should undefined
-     * value assigned superfluous property be allowed or not?
-     *
-     * Note that, this option only works on {@link equals} function. Other function
-     * like {@link assertEquals} or {@link validateEquals} would ignore this option
-     * value and always allow the `undefined` value.
-     *
-     * @default true
-     */
-    undefined?: boolean;
-}
+export interface ITransformOptions {
+    /**
+     * Whether to validate finite number or not.
+     *
+     * If configured true, number typed values would be validated by Number.isNaN().
+     *
+     * However, whatever you configure, it would be ignored when marshaling or parsing.
+     *
+     *   - when marshaling, always be true
+     *     - assertStringify()
+     *     - validateEncode()
+     *   - when parsing, always be false
+     *     - assertParse()
+     *     - isDecode()
+     *
+     * @default false
+     */
+    finite?: boolean;
+
+    /**
+     * Whether to validate finite number or not.
+     *
+     * If configured true, number typed values would be validated by Number.isFinite().
+     *
+     * However, whatever you configure, it can be ignored in below case.
+     *
+     *   - when `finite` option is true, this option would be ignored
+     *   - when marshaling, always be true
+     *     - assertStringify()
+     *     - validateEncode()
+     *   - when parsing, always be false
+     *     - assertParse()
+     *     - isDecode()
+     *
+     * @default false
+     */
+    numeric?: boolean;
+
+    /**
+     * Whether to validate functional type or not.
+     *
+     * However, whatever you configure, it becomes false when marshaling or parsing.
+     *
+     * @default false
+     */
+    functional?: boolean;
+
+    /**
+     * Whether to check undefined value or not.
+     *
+     * JavaScript can assign `undefined` value to a specific property and it is an
+     * issue when validating without allowing superfluous properties. Should undefined
+     * value assigned superfluous property be allowed or not?
+     *
+     * Note that, this option only works on {@link equals} function. Other function
+     * like {@link assertEquals} or {@link validateEquals} would ignore this option
+     * value and always allow the `undefined` value.
+     *
+     * @default true
+     */
+    undefined?: boolean;
+}