Current File : /www/specpages-backup/node_modules/ow/dist/source/predicates/string.d.ts
import { Predicate, PredicateOptions } from './predicate';
export declare class StringPredicate extends Predicate<string> {
/**
@hidden
*/
constructor(options?: PredicateOptions);
/**
Test a string to have a specific length.
@param length - The length of the string.
*/
length(length: number): this;
/**
Test a string to have a minimum length.
@param length - The minimum length of the string.
*/
minLength(length: number): this;
/**
Test a string to have a maximum length.
@param length - The maximum length of the string.
*/
maxLength(length: number): this;
/**
Test a string against a regular expression.
@param regex - The regular expression to match the value with.
*/
matches(regex: RegExp): this;
/**
Test a string to start with a specific value.
@param searchString - The value that should be the start of the string.
*/
startsWith(searchString: string): this;
/**
Test a string to end with a specific value.
@param searchString - The value that should be the end of the string.
*/
endsWith(searchString: string): this;
/**
Test a string to include a specific value.
@param searchString - The value that should be included in the string.
*/
includes(searchString: string): this;
/**
Test if the string is an element of the provided list.
@param list - List of possible values.
*/
oneOf(list: readonly string[]): this;
/**
Test a string to be empty.
*/
get empty(): this;
/**
Test a string to be not empty.
*/
get nonEmpty(): this;
/**
Test a string to be equal to a specified string.
@param expected - Expected value to match.
*/
equals(expected: string): this;
/**
Test a string to be alphanumeric.
*/
get alphanumeric(): this;
/**
Test a string to be alphabetical.
*/
get alphabetical(): this;
/**
Test a string to be numeric.
*/
get numeric(): this;
/**
Test a string to be a valid date.
*/
get date(): this;
/**
Test a non-empty string to be lowercase. Matching both alphabetical & numbers.
*/
get lowercase(): this;
/**
Test a non-empty string to be uppercase. Matching both alphabetical & numbers.
*/
get uppercase(): this;
/**
Test a string to be a valid URL.
*/
get url(): this;
}
Mini Shell