UNPKG

1.11 kBTypeScriptView Raw
1/**
2 * The options for sequence equal operations including a comparer and abort signal
3 *
4 * @interface SequencEqualOptions
5 * @template T The type of items to compare.
6 */
7export interface SequencEqualOptions<T> {
8 /**
9 * The comparer function which returns true if the items are equal, false otherwise.
10 *
11 * @memberof SequencEqualOptions
12 */
13 comparer?: (first: T, second: T) => boolean;
14}
15/**
16 * Determines whether two sequences are equal by comparing the elements pairwise.
17 *
18 * @export
19 * @template T The type of the elements in the source sequence.
20 * @param {Iterable<T>} source First iterable sequence to compare.
21 * @param {Iterable<T>} other Second iterable sequence to compare.
22 * @param {SequencEqualOptions<T>} [options] The sequence equal options which include an optional comparer and optional abort signal.
23 * @returns {boolean} A promise which indicates whether both sequences are of equal length and their
24 * corresponding elements are equal.
25 */
26export declare function sequenceEqual<T>(source: Iterable<T>, other: Iterable<T>, options?: SequencEqualOptions<T>): boolean;