typia/src/reflect.ts

Superfast runtime validators with only one line

import { IMetadataApplication } from "./schemas/metadata/IMetadataApplication";

/**
 * > You must configure the generic argument `Types`.
 *
 * Metadata Application.
 *
 * Creates a Metadata application which contains the metadata and components.
 *
 * Note that, all of the collection types like Array, Tuple and Objects are
 * stored in the {@link IMetadataApplication.components} property. Also, alias
 * types are stored in the {@link IMetadataApplication.aliases} property, too.
 *
 * @template Types Tuple of target types
 * @returns Metadata application
 *
 * @author Jeongho Nam - https://github.com/samchon
 */
function metadata(): never;

/**
 * Metadata Application.
 *
 * Creates a Metadata application which contains the metadata and components.
 *
 * Note that, all of the collection types like Array, Tuple and Objects are
 * stored in the {@link IMetadataApplication.components} property. Also, alias
 * types are stored in the {@link IMetadataApplication.aliases} property, too.
 *
 * @template Types Tuple of target types
 * @returns Metadata application
 *
 * @author Jeongho Nam - https://github.com/samchon
 */
function metadata<Types extends unknown[]>(): IMetadataApplication;

/**
 * @internal
 */
function metadata(): never {
  halt("metadata");
}

const metadataPure = /** @__PURE__ */ Object.assign<typeof metadata, {}>(
  metadata,
  { from: (input: unknown) => input },
);
export { metadataPure as metadata };

export function name<T, Regular extends boolean = false>(): string;
export function name(): never;
export function name(): never {
  halt("name");
}

/**
 * @internal
 */
function halt(name: string): never {
  throw new Error(
    `Error on typia.reflect.${name}(): no transform has been configured. Read and follow https://typia.io/docs/setup please.`,
  );
}