108 lines
3.6 KiB
TypeScript
108 lines
3.6 KiB
TypeScript
|
import { BasePredicate, testSymbol } from './base-predicate';
|
||
|
|
import { Main } from '..';
|
||
|
|
/**
|
||
|
|
Function executed when the provided validation fails.
|
||
|
|
|
||
|
|
@param value - The tested value.
|
||
|
|
@param label - Label of the tested value.
|
||
|
|
|
||
|
|
@returns {string} - The actual error message.
|
||
|
|
*/
|
||
|
|
export declare type ValidatorMessageBuilder<T> = (value: T, label?: string) => string;
|
||
|
|
/**
|
||
|
|
@hidden
|
||
|
|
*/
|
||
|
|
export interface Validator<T> {
|
||
|
|
message(value: T, label?: string, result?: any): string;
|
||
|
|
validator(value: T): unknown;
|
||
|
|
/**
|
||
|
|
Provide custom message used by `not` operator.
|
||
|
|
|
||
|
|
When absent, the return value of `message()` is used and 'not' is inserted after the first 'to', e.g. `Expected 'smth' to be empty` -> `Expected 'smth' to not be empty`.
|
||
|
|
*/
|
||
|
|
negatedMessage?(value: T, label: string): string;
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
@hidden
|
||
|
|
*/
|
||
|
|
export interface PredicateOptions {
|
||
|
|
optional?: boolean;
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
@hidden
|
||
|
|
*/
|
||
|
|
export interface Context<T = unknown> extends PredicateOptions {
|
||
|
|
validators: Array<Validator<T>>;
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
@hidden
|
||
|
|
*/
|
||
|
|
export declare const validatorSymbol: unique symbol;
|
||
|
|
export declare type CustomValidator<T> = (value: T) => {
|
||
|
|
/**
|
||
|
|
Should be `true` if the validation is correct.
|
||
|
|
*/
|
||
|
|
validator: boolean;
|
||
|
|
/**
|
||
|
|
The error message which should be shown if the `validator` is `false`. Or a error function which returns the error message and accepts the label as first argument.
|
||
|
|
*/
|
||
|
|
message: string | ((label: string) => string);
|
||
|
|
};
|
||
|
|
/**
|
||
|
|
@hidden
|
||
|
|
*/
|
||
|
|
export declare class Predicate<T = unknown> implements BasePredicate<T> {
|
||
|
|
private readonly type;
|
||
|
|
private readonly options;
|
||
|
|
private readonly context;
|
||
|
|
constructor(type: string, options?: PredicateOptions);
|
||
|
|
/**
|
||
|
|
@hidden
|
||
|
|
*/
|
||
|
|
[testSymbol](value: T, main: Main, label: string | Function, idLabel: boolean): asserts value is T;
|
||
|
|
/**
|
||
|
|
@hidden
|
||
|
|
*/
|
||
|
|
get [validatorSymbol](): Array<Validator<T>>;
|
||
|
|
/**
|
||
|
|
Invert the following validators.
|
||
|
|
*/
|
||
|
|
get not(): this;
|
||
|
|
/**
|
||
|
|
Test if the value matches a custom validation function. The validation function should return an object containing a `validator` and `message`. If the `validator` is `false`, the validation fails and the `message` will be used as error message. If the `message` is a function, the function is invoked with the `label` as argument to let you further customize the error message.
|
||
|
|
|
||
|
|
@param customValidator - Custom validation function.
|
||
|
|
*/
|
||
|
|
validate(customValidator: CustomValidator<T>): this;
|
||
|
|
/**
|
||
|
|
Test if the value matches a custom validation function. The validation function should return `true` if the value passes the function. If the function either returns `false` or a string, the function fails and the string will be used as error message.
|
||
|
|
|
||
|
|
@param validator - Validation function.
|
||
|
|
*/
|
||
|
|
is(validator: (value: T) => boolean | string): this;
|
||
|
|
/**
|
||
|
|
Provide a new error message to be thrown when the validation fails.
|
||
|
|
|
||
|
|
@param newMessage - Either a string containing the new message or a function returning the new message.
|
||
|
|
|
||
|
|
@example
|
||
|
|
```
|
||
|
|
ow('🌈', 'unicorn', ow.string.equals('🦄').message('Expected unicorn, got rainbow'));
|
||
|
|
//=> ArgumentError: Expected unicorn, got rainbow
|
||
|
|
```
|
||
|
|
|
||
|
|
@example
|
||
|
|
```
|
||
|
|
ow('🌈', ow.string.minLength(5).message((value, label) => `Expected ${label}, to have a minimum length of 5, got \`${value}\``));
|
||
|
|
//=> ArgumentError: Expected string, to be have a minimum length of 5, got `🌈`
|
||
|
|
```
|
||
|
|
*/
|
||
|
|
message(newMessage: string | ValidatorMessageBuilder<T>): this;
|
||
|
|
/**
|
||
|
|
Register a new validator.
|
||
|
|
|
||
|
|
@param validator - Validator to register.
|
||
|
|
*/
|
||
|
|
addValidator(validator: Validator<T>): this;
|
||
|
|
}
|