aiparking_api/node_modules/ow/dist/lib/predicates/set.d.ts
2020-02-02 15:24:30 +07:00

58 lines
1.6 KiB
TypeScript

import { Predicate, Context } from './predicate';
export declare class SetPredicate<T = any> extends Predicate<Set<T>> {
/**
* @hidden
*/
constructor(context?: Context<Set<T>>);
/**
* Test a Set to have a specific size.
*
* @param size The size of the Set.
*/
size(size: number): this;
/**
* Test an Size to have a minimum size.
*
* @param size The minimum size of the Set.
*/
minSize(size: number): this;
/**
* Test an Set to have a maximum size.
*
* @param size The maximum size of the Set.
*/
maxSize(size: number): this;
/**
* Test a Set to include all the provided items. The items are tested by identity, not structure.
*
* @param items The items that should be a item in the Set.
*/
has(...items: T[]): this;
/**
* Test a Set to include any of the provided items. The items are tested by identity, not structure.
*
* @param items The items that could be a item in the Set.
*/
hasAny(...items: T[]): this;
/**
* Test all the items in the Set to match the provided predicate.
*
* @param predicate The predicate that should be applied against every item in the Set.
*/
ofType(predicate: Predicate<T>): this;
/**
* Test a Set to be empty.
*/
readonly empty: this;
/**
* Test a Set to be not empty.
*/
readonly nonEmpty: this;
/**
* Test a Set to be deeply equal to the provided Set.
*
* @param expected Expected Set to match.
*/
deepEqual(expected: Set<T>): this;
}