@ts-fluentvalidation/core
Version:
Core library of @ts-fluentvalidation providing validations in a fluent syntax.
32 lines (31 loc) • 1.01 kB
TypeScript
import { ValidationFailure } from './validation-failure';
/**
* Represents the result of a validation operation.
*/
export interface ValidationResult {
/**
* Gets the validation failures.
*/
readonly failures: ValidationFailure[];
/**
* Gets a value indicating whether the validation operation succeeded.
*/
readonly isValid: boolean;
/**
* Adds the specified validation failures to the result.
*
* @param validationFailures The validation failures to add.
*/
addFailures(...validationFailures: ValidationFailure[]): void;
/**
* Joins all failure messages into a single string.
*
* @param separator The separator to use when joining the failure messages.
*/
toString(separator?: string): string;
/**
* Converts the validation failures to a dictionary.
*/
toDictionary(): Record<string, string[]>;
}
export declare function createValidationResult(failures?: ValidationFailure[]): ValidationResult;