Skip to main content

Class: RefinementTypeInfo

types.refinement type info.

Extends​

Constructors​

Constructor​

new RefinementTypeInfo(
   thisType, 
   baseType, 
   checkFunction, 
   typeName
): RefinementTypeInfo;

Parameters​

ParameterType
thisTypeAnyStandardType
baseTypeAnyStandardType
checkFunction(data) => boolean | TypeCheckError | null
typeNamestring | undefined

Returns​

RefinementTypeInfo

Overrides​

TypeInfo.constructor

Properties​

baseType​

readonly baseType: AnyStandardType;

checkFunction​

readonly checkFunction: (data) => boolean | TypeCheckError | null;

Parameters​

ParameterType
dataany

Returns​

boolean | TypeCheckError | null

kind​

readonly kind: "refinement" = "refinement";

Overrides​

TypeInfo.kind

thisType​

readonly thisType: AnyStandardType;

Inherited from​

TypeInfo.thisType

typeName​

readonly typeName: string | undefined;

Accessors​

baseTypeInfo​

Get Signature​

get baseTypeInfo(): TypeInfo;
Returns​

TypeInfo