@types/type-check/README.md

TypeScript definitions for type-check

# Installation
> `npm install --save @types/type-check`

# Summary
This package contains type definitions for type-check (https://github.com/gkz/type-check).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/type-check.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/type-check/index.d.ts)
````ts
export const VERSION: string;

export interface CustomType {
    typeOf: string;
    validate: (input: unknown) => boolean;
}

export interface CustomTypes {
    [typeName: string]: CustomType;
}

export interface Options {
    customTypes?: CustomTypes;
}

export function typeCheck(type: string, input: unknown, options?: Options): boolean;

// This is, in fact, a single element tuple.
// eslint-disable-next-line @definitelytyped/no-single-element-tuple-type
export type ParsedType = [ParsedTypeData];

export interface ParsedTypeData {
    type: string;
}

export function parseType(type: string): ParsedType;

export function parsedTypeCheck(parsedType: ParsedType, input: string, options?: Options): boolean;

````

### Additional Details
 * Last updated: Fri, 06 Sep 2024 21:07:35 GMT
 * Dependencies: none

# Credits
These definitions were written by [Hans Windhoff](https://github.com/hansrwindhoff).