Skip to content

[@types/underscore] Collection and Array Tests - Find and Reject #45994

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
typescript-bot merged 10 commits into from
Jul 11, 2020
+279 −336
Merged

[@types/underscore] Collection and Array Tests - Find and Reject #45994

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
c20b340
Updating type definitions for find and reject and adding tests.
reubenrybnik Jul 10, 2020
761d36d
Updating summary comment indentation for a few see comments that I mi…
reubenrybnik Jul 10, 2020
cec8ac7
Updating TypeOfCollection<any> to result in any instead of unknown.
reubenrybnik Jul 10, 2020
9f5f0b8
Moving the never check up to the top of TypeOfCollection for future-p…
reubenrybnik Jul 10, 2020
154352f
Adding support and tests for identity iteratees in find, filter, and …
reubenrybnik Jul 10, 2020
da607ef
Adding any and never tests to OOP and chain.
reubenrybnik Jul 10, 2020
b4f42b5
Summary comment updates suggested by @jgonggrijp.
reubenrybnik Jul 10, 2020
6cfb95e
Adding a boolean iterator that won't cause collection types to be inf…
reubenrybnik Jul 10, 2020
1a3e5af
Fixing identity iteratee tests that I didn't properly switch to an id…
reubenrybnik Jul 10, 2020
71bbdd7
Remove a filter designation from a reject test group.
reubenrybnik Jul 10, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
261 changes: 94 additions & 167 deletions types/underscore/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,8 @@ declare module _ {
type TypeOfDictionary<V> = V extends Dictionary<infer T> ? T : never;

type TypeOfCollection<V> =
V extends List<infer T> ? T
V extends never ? any
: V extends List<infer T> ? T
: V extends Dictionary<infer T> ? T
: never;

Expand Down Expand Up @@ -322,88 +323,44 @@ declare module _ {
foldr: UnderscoreStatic['reduceRight'];

/**
* Looks through each value in the list, returning the first one that passes a truth
* test (iterator). The function returns as soon as it finds an acceptable element,
* and doesn't traverse the entire list.
* @param list Searches for a value in this list.
* @param iterator Search iterator function for each element in `list`.
* @param context `this` object in `iterator`, optional.
* @return The first acceptable found element in `list`, if nothing is found undefined/null is returned.
**/
find<T>(
list: _.List<T>,
iterator: _.ListIterator<T, boolean>,
context?: any): T | undefined;

/**
* @see _.find
**/
find<T>(
object: _.Dictionary<T>,
iterator: _.ObjectIterator<T, boolean>,
context?: any): T | undefined;

/**
* @see _.find
**/
find<T, U extends {}>(
object: _.List<T> | _.Dictionary<T>,
iterator: U): T | undefined;

/**
* @see _.find
**/
find<T>(
object: _.List<T> | _.Dictionary<T>,
iterator: string): T | undefined;

/**
* @see _.find
**/
detect<T>(
list: _.List<T>,
iterator: _.ListIterator<T, boolean>,
context?: any): T | undefined;

/**
* @see _.find
**/
detect<T>(
object: _.Dictionary<T>,
iterator: _.ObjectIterator<T, boolean>,
context?: any): T | undefined;

/**
* @see _.find
**/
detect<T, U extends {}>(
object: _.List<T> | _.Dictionary<T>,
iterator: U): T | undefined;
* Looks through each value in the collection, returning the first one that passes a
* truth test (iteratee), or undefined if no value passes the test. The function
* returns as soon as it finds an acceptable element, and doesn't traverse the entire
* collection.
* @param collection Searches for a value in this collection.
* @param iteratee The truth test to apply.
* @param context `this` object in `iteratee`, optional.
* @return The first element in `collection` that passes the truth test or undefined
* if no elements pass.
**/
find<V extends Collection<any>>(
collection: V,
iteratee?: Iteratee<V, boolean>,
context?: any
): TypeOfCollection<V> | undefined;

/**
* @see _.find
**/
detect<T>(
object: _.List<T> | _.Dictionary<T>,
iterator: string): T | undefined;
* @see find
**/
detect: UnderscoreStatic['find'];

/**
* Looks through each value in the collection, returning an array of all the values that pass a truth
* test (iteratee).
* @param collection The collection to filter.
* @param iteratee The truth test to apply.
* @param context `this` object in `iteratee`, optional.
* @returns The filtered set of values.
* @returns The set of values that pass the truth test.
**/
filter<V extends Collection<any>>(
collection: V,
iteratee: Iteratee<V, boolean>,
iteratee?: Iteratee<V, boolean>,
context?: any
): TypeOfCollection<V>[];

/**
* @see filter
**/
* @see filter
**/
select: UnderscoreStatic['filter'];

/**
Expand All @@ -428,26 +385,18 @@ declare module _ {
properties: U): T | undefined;

/**
* Returns the values in list without the elements that the truth test (iterator) passes.
* The opposite of filter.
* Return all the elements for which a truth test fails.
* @param list Reject elements within this list.
* @param iterator Reject iterator function for each element in `list`.
* @param context `this` object in `iterator`, optional.
* @return The rejected list of elements.
**/
reject<T>(
list: _.List<T>,
iterator: _.ListIterator<T, boolean>,
context?: any): T[];

/**
* @see _.reject
**/
reject<T>(
object: _.Dictionary<T>,
iterator: _.ObjectIterator<T, boolean>,
context?: any): T[];
* Returns the values in `collection` without the elements that pass a truth test (iteratee).
* The opposite of filter.
* @param collection The collection to filter.
* @param iteratee The truth test to apply.
* @param context `this` object in `iteratee`, optional.
* @return The set of values that fail the truth test.
**/
reject<V extends Collection<any>>(
collection: V,
iteratee?: Iteratee<V, boolean>,
context?: any
): TypeOfCollection<V>[];

/**
* Returns true if all of the values in the list pass the iterator truth test. Delegates to the
Expand Down Expand Up @@ -4193,13 +4142,13 @@ declare module _ {
): TResult | TypeOfCollection<V> | undefined;

/**
* @see reduce
**/
* @see reduce
**/
inject: Underscore<T, V>['reduce'];

/**
* @see reduce
**/
* @see reduce
**/
foldl: Underscore<T, V>['reduce'];

/**
Expand All @@ -4221,53 +4170,39 @@ declare module _ {
): TResult | TypeOfCollection<V> | undefined;

/**
* @see reduceRight
**/
* @see reduceRight
**/
foldr: Underscore<T, V>['reduceRight'];

/**
* Wrapped type `any[]`.
* @see _.find
**/
find<T>(iterator: _.ListIterator<T, boolean> | _.ObjectIterator<T, boolean>, context?: any): T | undefined;

/**
* @see _.find
**/
find<T, U extends {}>(interator: U): T | undefined;

/**
* @see _.find
**/
find<T>(interator: string): T | undefined;

/**
* @see _.find
**/
detect<T>(iterator: _.ListIterator<T, boolean> | _.ObjectIterator<T, boolean>, context?: any): T | undefined;

/**
* @see _.find
**/
detect<T, U extends {}>(interator?: U): T | undefined;
* Looks through each value in the wrapped collection, returning the first one that passes a
* truth test (iteratee), or undefined if no value passes the test. The function
* returns as soon as it finds an acceptable element, and doesn't traverse the entire
* collection.
* @param iteratee The truth test to apply.
* @param context `this` object in `iteratee`, optional.
* @return The first element in the wrapped collection that passes the truth test or undefined
* if no elements pass.
**/
find(iteratee?: Iteratee<V, boolean>, context?: any): T | undefined;

/**
* @see _.find
**/
detect<T>(interator?: string): T | undefined;
* @see find
**/
detect: Underscore<T, V>['find'];

/**
* Looks through each value in the wrapped collection, returning an array of all the values that pass a truth
* test (iteratee).
* @param iteratee The truth test to apply.
* @param context `this` object in `iteratee`, optional.
* @returns The filtered set of values.
* @returns The set of values that pass the truth test.
**/
filter(iteratee: Iteratee<V, boolean>, context?: any): T[];
filter(iteratee?: Iteratee<V, boolean>, context?: any): T[];

/**
* @see filter
**/
* @see filter
**/
select: Underscore<T, V>['filter'];

/**
Expand All @@ -4283,10 +4218,13 @@ declare module _ {
findWhere<U extends {}>(properties: U): T | undefined;

/**
* Wrapped type `any[]`.
* @see _.reject
**/
reject(iterator: _.ListIterator<T, boolean>, context?: any): T[];
* Returns the values in the wrapped collection without the elements that pass a truth test (iteratee).
* The opposite of filter.
* @param iteratee The truth test to apply.
* @param context `this` object in `iteratee`, optional.
* @return The set of values that fail the truth test.
**/
reject(iteratee?: Iteratee<V, boolean>, context?: any): T[];

/**
* Wrapped type `any[]`.
Expand Down Expand Up @@ -5181,13 +5119,13 @@ declare module _ {
): _ChainSingle<TResult | TypeOfCollection<V> | undefined>;

/**
* @see reduce
**/
* @see reduce
**/
inject: _Chain<T, V>['reduce'];

/**
* @see reduce
**/
* @see reduce
**/
foldl: _Chain<T, V>['reduce'];

/**
Expand All @@ -5209,49 +5147,35 @@ declare module _ {
): _ChainSingle<TResult | TypeOfCollection<V> | undefined>;

/**
* @see reduceRight
**/
* @see reduceRight
**/
foldr: _Chain<T, V>['reduceRight'];

/**
* Wrapped type `any[]`.
* @see _.find
**/
find<T>(iterator: _.ListIterator<T, boolean> | _.ObjectIterator<T, boolean>, context?: any): _ChainSingle<T | undefined>;

/**
* @see _.find
**/
find<T, U extends {}>(interator: U): _ChainSingle<T | undefined>;

/**
* @see _.find
**/
find<T>(interator: string): _ChainSingle<T | undefined>;

/**
* @see _.find
**/
detect<T>(iterator: _.ListIterator<T, boolean> | _.ObjectIterator<T, boolean>, context?: any): _ChainSingle<T | undefined>;

/**
* @see _.find
**/
detect<T, U extends {}>(interator: U): _ChainSingle<T | undefined>;
* Looks through each value in the wrapped collection, returning the first one that passes a
* truth test (iteratee), or undefined if no value passes the test. The function
* returns as soon as it finds an acceptable element, and doesn't traverse the entire
* collection.
* @param iteratee The truth test to apply.
* @param context `this` object in `iteratee`, optional.
* @return A chain wrapper containing the first element in the wrapped collection that passes
* the truth test or undefined if no elements pass.
**/
find(iteratee?: _ChainIteratee<V, boolean, T>, context?: any): _ChainSingle<T | undefined>;

/**
* @see _.find
**/
detect<T>(interator: string): _ChainSingle<T | undefined>;
* @see find
**/
detect: _Chain<T, V>['find'];

/**
* Looks through each value in the wrapped collection, returning an array of all the values that pass a truth
* test (iteratee).
* @param iteratee The truth test to apply.
* @param context `this` object in `iteratee`, optional.
* @returns The filtered set of values in a chain wrapper.
* @returns The set of values that pass a truth test in a chain wrapper.
**/
filter(iteratee: _ChainIteratee<V, any, T>, context?: any): _Chain<T, T[]>;
filter(iteratee?: _ChainIteratee<V, any, T>, context?: any): _Chain<T, T[]>;

/**
* @see filter
Expand All @@ -5271,10 +5195,13 @@ declare module _ {
findWhere<U extends {}>(properties: U): _ChainSingle<T>;

/**
* Wrapped type `any[]`.
* @see _.reject
**/
reject(iterator: _.ListIterator<T, boolean>, context?: any): _Chain<T>;
* Returns the values in the wrapped collection without the elements that pass a truth test (iteratee).
* The opposite of filter.
* @param iteratee The truth test to apply.
* @param context `this` object in `iteratee`, optional.
* @return The set of values that fail the truth test in a chain wrapper.
**/
reject(iteratee?: _ChainIteratee<V, boolean, T>, context?: any): _Chain<T, T[]>;

/**
* Wrapped type `any[]`.
Expand Down
Loading