Interface ValidationCollector<Specifics>

interface ValidationCollector<Specifics extends TypirSpecifics> {
    addListener(listener: ValidationCollectorListener<Specifics>): void;
    addValidationRule<InputType extends unknown = Specifics["LanguageType"]>(
        rule: ValidationRule<Specifics, InputType>,
        options?: Partial<ValidationRuleOptions>,
    ): void;
    removeListener(listener: ValidationCollectorListener<Specifics>): void;
    removeValidationRule<InputType extends unknown = Specifics["LanguageType"]>(
        rule: ValidationRule<Specifics, InputType>,
        options?: Partial<ValidationRuleOptions>,
    ): void;
    validate(
        languageNode: Specifics["LanguageType"],
    ): ValidationProblem<Specifics, Specifics["LanguageType"]>[];
    validateAfter(
        languageNode: Specifics["LanguageType"],
    ): ValidationProblem<Specifics, Specifics["LanguageType"]>[];
    validateBefore(
        languageNode: Specifics["LanguageType"],
    ): ValidationProblem<Specifics, Specifics["LanguageType"]>[];
}

Type Parameters

Specifics extends TypirSpecifics

Hierarchy (View Summary)

ValidationCollector
- LangiumValidationCollector

Implemented by

DefaultValidationCollector

Index

Methods

addListener addValidationRule removeListener removeValidationRule validate validateAfter validateBefore

Methods

addListener

addListener(listener: ValidationCollectorListener<Specifics>): void
Parameters
- listener: ValidationCollectorListener<Specifics>
Returns void
- Defined in services/validation.ts:234

addValidationRule

addValidationRule<InputType extends unknown = Specifics["LanguageType"]>(
rule: ValidationRule<Specifics, InputType>,
options?: Partial<ValidationRuleOptions>,
): void
Registers a validation rule.
Type Parameters
- InputType extends unknown = Specifics["LanguageType"]
Parameters
- rule: ValidationRule<Specifics, InputType>
  a new validation rule
- Optionaloptions: Partial<ValidationRuleOptions>
  some more options to control the handling of the added validation rule
Returns void
- Defined in services/validation.ts:226

removeListener

removeListener(listener: ValidationCollectorListener<Specifics>): void
Parameters
- listener: ValidationCollectorListener<Specifics>
Returns void
- Defined in services/validation.ts:235

removeValidationRule

removeValidationRule<InputType extends unknown = Specifics["LanguageType"]>(
rule: ValidationRule<Specifics, InputType>,
options?: Partial<ValidationRuleOptions>,
): void
Removes a validation rule.
Type Parameters
- InputType extends unknown = Specifics["LanguageType"]
Parameters
- rule: ValidationRule<Specifics, InputType>
  the validation rule to remove
- Optionaloptions: Partial<ValidationRuleOptions>
  the same options as given for the registration of the validation rule must be given for the removal!
Returns void
- Defined in services/validation.ts:232

validate

validate(
languageNode: Specifics["LanguageType"],
): ValidationProblem<Specifics, Specifics["LanguageType"]>[]
Parameters
- languageNode: Specifics["LanguageType"]
Returns ValidationProblem<Specifics, Specifics["LanguageType"]>[]
- Defined in services/validation.ts:218

validateAfter

validateAfter(
languageNode: Specifics["LanguageType"],
): ValidationProblem<Specifics, Specifics["LanguageType"]>[]
Parameters
- languageNode: Specifics["LanguageType"]
Returns ValidationProblem<Specifics, Specifics["LanguageType"]>[]
- Defined in services/validation.ts:219

validateBefore

validateBefore(
languageNode: Specifics["LanguageType"],
): ValidationProblem<Specifics, Specifics["LanguageType"]>[]
Parameters
- languageNode: Specifics["LanguageType"]
Returns ValidationProblem<Specifics, Specifics["LanguageType"]>[]
- Defined in services/validation.ts:217