External module "node_modules/@types/prop-types/index.d"

Index

Interfaces

Type aliases

Variables

Functions

Type aliases

InferProps

InferProps<V>: InferPropsInner<Pick<V, RequiredKeys<V>>> & Partial<InferPropsInner<Pick<V, OptionalKeys<V>>>>

Type parameters

V

InferPropsInner

InferPropsInner<V>: object

Type parameters

V

Type declaration

InferType

InferType<V>: InferType<V>

Type parameters

V

IsOptional

IsOptional<T>: IsOptional<T>

Type parameters

T

OptionalKeys

OptionalKeys<V>: Exclude<keyof V, RequiredKeys<V>>

Type parameters

V

ReactComponentLike

ReactComponentLike: string | function | object

ReactNodeLike

ReactNodeLike: __type | ReactElementLike | ReactNodeArray | string | number | boolean | null | undefined

RequiredKeys

RequiredKeys<V>: { [K in keyof V]-?: Exclude<V[K], undefined> extends Validator<infer T> ? IsOptional<T> extends true ? never : K : never; }[keyof V]

Type parameters

V

ValidationMap

ValidationMap<T>: object

Type parameters

T

Type declaration

Variables

Const any

any: Requireable<any>

Const array

array: Requireable<any[]>

Const bool

bool: Requireable<boolean>

Const element

element: Requireable<ReactElementLike>

Const elementType

elementType: Requireable<ReactComponentLike>

Const func

func: Requireable<function>

Const node

node: Requireable<ReactNodeLike>

Const nominalTypeHack

nominalTypeHack: keyof symbol

Const number

number: Requireable<number>

Const object

object: Requireable<object>

Const string

string: Requireable<string>

Const symbol

symbol: Requireable<symbol>

Functions

arrayOf

arrayOf<T>(type: Validator<T>): Requireable<T[]>

- Defined in node_modules/@types/prop-types/index.d.ts:72
Type parameters
- T
Parameters
- type: Validator<T>
Returns Requireable<T[]>

checkPropTypes

checkPropTypes(typeSpecs: any, values: any, location: string, componentName: string, getStack?: undefined | function): void

- Defined in node_modules/@types/prop-types/index.d.ts:87
Assert that the values match with the type specs. Error messages are memorized and will only be shown once.

Parameters
- typeSpecs: any
  
  Map of name to a ReactPropType
- values: any
  
  Runtime values that need to be type-checked
- location: string
  
  e.g. "prop", "context", "child context"
- componentName: string
  
  Name of the component for error messages
- Optional getStack: undefined | function
  
  Returns the component stack
Returns void

exact

exact<P>(type: P): Requireable<Required<InferProps<P>>>

- Defined in node_modules/@types/prop-types/index.d.ts:75
Type parameters
- P: ValidationMap<any>
Parameters
- type: P
Returns Requireable<Required<InferProps<P>>>

instanceOf

instanceOf<T>(expectedClass: object): Requireable<T>

- Defined in node_modules/@types/prop-types/index.d.ts:69
Type parameters
- T
Parameters
- expectedClass: object
Returns Requireable<T>

objectOf

objectOf<T>(type: Validator<T>): Requireable<object>

- Defined in node_modules/@types/prop-types/index.d.ts:73
Type parameters
- T
Parameters
- type: Validator<T>
Returns Requireable<object>

oneOf

oneOf<T>(types: ReadonlyArray<T>): Requireable<T>

- Defined in node_modules/@types/prop-types/index.d.ts:70
Type parameters
- T
Parameters
- types: ReadonlyArray<T>
Returns Requireable<T>

oneOfType

oneOfType<T>(types: T[]): Requireable<NonNullable<InferType<T>>>

- Defined in node_modules/@types/prop-types/index.d.ts:71
Type parameters
- T: Validator<any>
Parameters
- types: T[]
Returns Requireable<NonNullable<InferType<T>>>

resetWarningCache

resetWarningCache(): void

- Defined in node_modules/@types/prop-types/index.d.ts:92
Only available if NODE_ENV=production

Returns void

shape

shape<P>(type: P): Requireable<InferProps<P>>

- Defined in node_modules/@types/prop-types/index.d.ts:74
Type parameters
- P: ValidationMap<any>
Parameters
- type: P
Returns Requireable<InferProps<P>>

Generated using TypeDoc