mirror of
https://github.com/zhigang1992/DefinitelyTyped.git
synced 2026-05-31 19:12:20 +08:00
ee0fd76b1a
I used the jsdoc as guide in https://github.com/facebook/prop-types/blob/master/checkPropTypes.js
43 lines
1.8 KiB
TypeScript
43 lines
1.8 KiB
TypeScript
// Type definitions for prop-types 15.5
|
|
// Project: https://github.com/reactjs/prop-types
|
|
// Definitions by: DovydasNavickas <https://github.com/DovydasNavickas>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
// TypeScript Version: 2.2
|
|
|
|
export type Validator<T> = (object: T, key: string, componentName: string, ...rest: any[]) => Error | null;
|
|
|
|
export interface Requireable<T> extends Validator<T> {
|
|
isRequired: Validator<T>;
|
|
}
|
|
|
|
export type ValidationMap<T> = {[K in keyof T]?: Validator<T> };
|
|
|
|
export const any: Requireable<any>;
|
|
export const array: Requireable<any>;
|
|
export const bool: Requireable<any>;
|
|
export const func: Requireable<any>;
|
|
export const number: Requireable<any>;
|
|
export const object: Requireable<any>;
|
|
export const string: Requireable<any>;
|
|
export const node: Requireable<any>;
|
|
export const element: Requireable<any>;
|
|
export const symbol: Requireable<any>;
|
|
export function instanceOf(expectedClass: {}): Requireable<any>;
|
|
export function oneOf(types: any[]): Requireable<any>;
|
|
export function oneOfType(types: Array<Validator<any>>): Requireable<any>;
|
|
export function arrayOf(type: Validator<any>): Requireable<any>;
|
|
export function objectOf(type: Validator<any>): Requireable<any>;
|
|
export function shape(type: ValidationMap<any>): Requireable<any>;
|
|
|
|
/**
|
|
* Assert that the values match with the type specs.
|
|
* Error messages are memorized and will only be shown once.
|
|
*
|
|
* @param typeSpecs Map of name to a ReactPropType
|
|
* @param values Runtime values that need to be type-checked
|
|
* @param location e.g. "prop", "context", "child context"
|
|
* @param componentName Name of the component for error messages.
|
|
* @param getStack Returns the component stack.
|
|
*/
|
|
export function checkPropTypes(typeSpecs: any, values: any, location: string, componentName: string, getStack?: () => any): void;
|