Interface InferCurrentTypeRule<TypeType, Specifics, T>

An inference rule which is dedicated for inferrring a certain type. This utility type is often used for inference rules which are annotated to the declaration of a type. At least one of the properties needs to be specified.

interface InferCurrentTypeRule<
    TypeType extends Type,
    Specifics extends TypirSpecifics,
    T extends Specifics["LanguageType"] = Specifics["LanguageType"],
> {
    filter?: (languageNode: Specifics["LanguageType"]) => languageNode is T;
    languageKey?: string | string[];
    matching?: (languageNode: T, typeToInfer: TypeType) => boolean;
    skipThisRuleIfThisTypeAlreadyExists?:
        | boolean
        | (existingType: TypeType) => boolean;
    validation?:
        | InferCurrentTypeValidationRule<TypeType, Specifics, T>
        | InferCurrentTypeValidationRule<TypeType, Specifics, T>[];
}

Type Parameters

Hierarchy (View Summary)

Properties

filter? languageKey? matching? skipThisRuleIfThisTypeAlreadyExists? validation?

Properties

Optionalfilter

filter?: (languageNode: Specifics["LanguageType"]) => languageNode is T

OptionallanguageKey

languageKey?: string | string[]

Optionalmatching

matching?: (languageNode: T, typeToInfer: TypeType) => boolean

OptionalskipThisRuleIfThisTypeAlreadyExists

skipThisRuleIfThisTypeAlreadyExists?:
    | boolean
    | (existingType: TypeType) => boolean

Optionalvalidation

validation?:
    | InferCurrentTypeValidationRule<TypeType, Specifics, T>
    | InferCurrentTypeValidationRule<TypeType, Specifics, T>[]

This validation will be applied to all language nodes for which the current type is inferred according to this inference rule. This validation is specific for this inference rule and this inferred type.

Settings

Member Visibility

On This Page

Properties