Current File : /www/specpages-backup/node_modules/ow/dist/source/index.d.ts
import { Predicate } from './predicates/predicate';
import { BasePredicate } from './predicates/base-predicate';
import { Modifiers } from './modifiers';
import { Predicates } from './predicates';
/**
@hidden
*/
export declare type Main = <T>(value: T, label: string | Function, predicate: BasePredicate<T>) => void;
export interface Ow extends Modifiers, Predicates {
/**
Test if the value matches the predicate. Throws an `ArgumentError` if the test fails.
@param value - Value to test.
@param predicate - Predicate to test against.
*/
<T>(value: T, predicate: BasePredicate<T>): void;
/**
Test if `value` matches the provided `predicate`. Throws an `ArgumentError` with the specified `label` if the test fails.
@param value - Value to test.
@param label - Label which should be used in error messages.
@param predicate - Predicate to test against.
*/
<T>(value: T, label: string, predicate: BasePredicate<T>): void;
/**
Returns `true` if the value matches the predicate, otherwise returns `false`.
@param value - Value to test.
@param predicate - Predicate to test against.
*/
isValid<T>(value: T, predicate: BasePredicate<T>): value is T;
/**
Create a reusable validator.
@param predicate - Predicate used in the validator function.
*/
create<T>(predicate: BasePredicate<T>): ReusableValidator<T>;
/**
Create a reusable validator.
@param label - Label which should be used in error messages.
@param predicate - Predicate used in the validator function.
*/
create<T>(label: string, predicate: BasePredicate<T>): ReusableValidator<T>;
}
/**
A reusable validator.
*/
export interface ReusableValidator<T> {
/**
Test if the value matches the predicate. Throws an `ArgumentError` if the test fails.
@param value - Value to test.
@param label - Override the label which should be used in error messages.
*/
(value: T, label?: string): void;
}
declare const _default: Ow;
export default _default;
export { BasePredicate, Predicate };
export { StringPredicate, NumberPredicate, BooleanPredicate, ArrayPredicate, ObjectPredicate, DatePredicate, ErrorPredicate, MapPredicate, WeakMapPredicate, SetPredicate, WeakSetPredicate, TypedArrayPredicate, ArrayBufferPredicate, DataViewPredicate, AnyPredicate, Shape } from './predicates';
export { ArgumentError } from './argument-error';
Mini Shell