Interface SubType

Analyzes, whether there is a sub type-relationship between two types.

The sub-type relationship might be direct or indirect (transitive). If both types are the same, no problems will be reported, since a type is considered as sub-type of itself (by definition).

interface SubType {
    getSubTypeProblem(
        subType: Type,
        superType: Type,
    ): undefined | SubTypeProblem;
    getSubTypeResult(subType: Type, superType: Type): SubTypeResult;
    isSubType(subType: Type, superType: Type): boolean;
    markAsSubType(
        subType: Type,
        superType: Type,
        options?: Partial<MarkSubTypeOptions>,
    ): void;
}

Implemented by

DefaultSubType

Index

Methods

getSubTypeProblem getSubTypeResult isSubType markAsSubType

Methods

getSubTypeProblem

getSubTypeProblem(subType: Type, superType: Type): undefined | SubTypeProblem
Parameters
- subType: Type
- superType: Type
Returns undefined | SubTypeProblem
- Defined in services/subtype.ts:61

getSubTypeResult

getSubTypeResult(subType: Type, superType: Type): SubTypeResult
Parameters
- subType: Type
- superType: Type
Returns SubTypeResult
- Defined in services/subtype.ts:62

isSubType

isSubType(subType: Type, superType: Type): boolean
Parameters
- subType: Type
- superType: Type
Returns boolean
- Defined in services/subtype.ts:60

markAsSubType

markAsSubType(
    subType: Type,
    superType: Type,
    options?: Partial<MarkSubTypeOptions>,
): void
Parameters
- subType: Type
- superType: Type
- Optionaloptions: Partial<MarkSubTypeOptions>
Returns void
- Defined in services/subtype.ts:64