Class ValidationResult

Результат валидации.

Hierarchy

  • ValidationResult

Accessors

hasErrors hasInfo hasWarnings isSuccessful empty

Constructors

constructor

Methods

aggregate convertToSuccessful format fromError fromText hasCancellationError hasErrorWithHttpCode hasSessionError removeHttpErrors toString

Properties

items

Accessors

hasErrors

  • get hasErrors(): boolean

  • Признак того, что результаты валидации содержат сообщения об ошибках.

    Returns boolean

hasInfo

  • get hasInfo(): boolean

  • Признак того, что результаты валидации содержат информационные сообщения.

    Returns boolean

hasWarnings

  • get hasWarnings(): boolean

  • Признак того, что результаты валидации содержат предупреждения.

    Returns boolean

isSuccessful

  • get isSuccessful(): boolean

  • Признак того, что валидации завершилась успехом.

    Returns boolean

Static empty

  • get empty(): ValidationResult

  • Пустой результат валидации.

    Returns ValidationResult

Constructors

constructor

  • Создаёт экземпляр класса с указанием сообщений, возникших при валидации.

    Parameters

    • items: readonly ValidationResultItem[]

      Сообщения, возникшие при валидации.

    Returns ValidationResult

Methods

aggregate

  • Выполняет объединение результатов валидации.

    Returns

    Объединённый результат валидации.

    Parameters

    • Rest ...params: (null | ValidationResult)[]

      Результаты валидации в порядке добавления.

    Returns ValidationResult

convertToSuccessful

  • Преобразует текущий результат валидации в успешный, в котором все ошибки заменяются на предупреждения,
    или возвращает текущий объект, если в нём нет сообщений-ошибок.

    Returns

    Результат валидации, основанный на текущем объекте, но гарантированно являющийся успешным.

    Returns ValidationResult

format

  • Возвращает простое текстовое представление для сообщения валидации.

    Returns

    Текстовое представление для сообщения валидации.

    Returns string

fromError

  • Возвращает результат валидации для исключения.

    Returns

    Результат валидации для текста сообщения.

    Parameters

    • error: unknown

      Исключение, для которого надо получить результат валидации, или строка с сообщением об ошибке

    • Optional params: null | Partial<IValidationResultItem>

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

    Returns ValidationResult

  • Возвращает результат валидации для исключения.

    Returns

    Результат валидации для текста сообщения.

    Parameters

    • error: unknown

      Исключение, для которого надо получить результат валидации, или строка с сообщением об ошибке

    • type: null | ValidationResultType

      Тип сообщения о валидации.

    Returns ValidationResult

fromText

  • Возвращает результат валидации для текста сообщения.

    Returns

    Результат валидации для текста сообщения.

    Parameters

    • message: string

      Строка текста, для которой надо получить валидации. Если строка равна пустой строке, то возвращается пустой объект empty

    • Optional params: null | Partial<IValidationResultItem>

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

    Returns ValidationResult

  • Возвращает результат валидации для текста сообщения.

    Returns

    Результат валидации для текста сообщения.

    Parameters

    • message: string

      Строка текста, для которой надо получить валидации. Если строка равна пустой строке, то возвращается пустой объект empty

    • type: null | ValidationResultType

      Тип сообщения о валидации.

    Returns ValidationResult

hasCancellationError

  • Returns boolean

hasErrorWithHttpCode

  • Parameters

    • code: number

    Returns boolean

hasSessionError

  • Parameters

    • objectName: string

    Returns boolean

removeHttpErrors

toString

  • Возвращает текстовое представление для сообщения валидации с указанным режимом вывода.

    Returns

    Текстовое представление для сообщения валидации.

    Parameters

    • level: ValidationLevel = ValidationLevel.General

      Режим вывода текста в результате валидации.

    Returns string

Properties

Readonly items

items: readonly ValidationResultItem[]

Сообщения, возникшие при валидации.

Generated using TypeDoc