types.typeguardfor.md

Home > @skunkteam/types > TypeguardFor

TypeguardFor type

The type of the type-guard that comes with each Type (the #is method).

Signature:

type TypeguardFor<ResultType> = <Input>(this: void, input: Input) => input is TypeguardResult<ResultType, Input>;

References: TypeguardResult

Remarks

Normally a typeguard wouldn't need the Input type-parameter, but this is needed for compatibility with Array#every. That method requires the use of this type-param.