Interface IKrCardValidationManager

Объект, управляющий валидацией карточки.

Hierarchy

  • IKrCardValidationManager

Implemented by

Methods

validateCard validateTask

Methods

validateCard

  • Выполняет валидацию основной карточки для заданного списка валидаторов.

    Parameters

    • validators: readonly CardTypeValidator[]

      Список валидаторов, посредством которых будет выполняться валидация.

    • mainCardTypeId: string

      Идентификатор типа основной карточки, валидация которой выполняется.

    • mainCard: Card

      Основная карточка, валидация которой выполняется.

    • storeMode: CardStoreMode

      Способ сохранения проверяемого объекта - карточки или файла.

    • Optional externalContextInfo: null | IStorage<unknown>

      Произвольно структурированная информация из внешнего контекста (например, контекста сохранения карточки), которая может быть заполнена валидатором и использована либо другими валидаторами, либо внешними расширениями. Значение null определяет, что внешний контекст неизвестен и для свойства будет создан пустой объект.

    • Optional modifyContextAction: null | ((context: CardValidationContext) => Promise<void>)

      Действие, выполняющее изменение контекста валидации перед его использованием, или null, если такое действие не требуется. Действие может использоваться, например, для указания ограничений по секциям валидации.

    • Optional validationMode: CardValidationMode

      Способ выполнения валидации. По умолчанию рекомендуется использовать CardValidationMode.Card.

    Returns Promise<CardValidationResult>

validateTask

  • Выполняет валидацию основной карточки и её карточки задания для заданного списка валидаторов.

    Parameters

    • validators: readonly CardTypeValidator[]

      Список валидаторов, посредством которых будет выполняться валидация.

    • mainCardTypeId: string

      Идентификатор типа основной карточки, валидация которой выполняется.

    • mainCard: Card

      Основная карточка, валидация которой выполняется.

    • storeMode: CardStoreMode

      Способ сохранения проверяемого объекта - задания.

    • taskCardTypeId: string

      Идентификатор типа карточки задания, валидация которой выполняется.

    • taskCard: Card

      Карточка задания, валидация которой выполняется, или null, если задание завершается без данных карточки.

    • Optional externalContextInfo: null | IStorage<unknown>

      Произвольно структурированная информация из внешнего контекста (например, контекста сохранения карточки), которая может быть заполнена валидатором и использована либо другими валидаторами, либо внешними расширениями. Значение null определяет, что внешний контекст неизвестен и для свойства будет создан пустой объект.

    • Optional modifyContextAction: null | ((context: CardValidationContext) => Promise<void>)

      Действие, выполняющее изменение контекста валидации перед его использованием, или null, если такое действие не требуется. Действие может использоваться, например, для указания ограничений по секциям валидации.

    • Optional validationMode: CardValidationMode

      Способ выполнения валидации. По умолчанию рекомендуется использовать CardValidationMode.Task.

    Returns Promise<CardValidationResult>

Generated using TypeDoc