Skip to content

[@types/underscore] Collection and Array Tests - Reduce and ReduceRight #45893

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 9 commits into from
Jul 7, 2020
+489 −123
Merged

[@types/underscore] Collection and Array Tests - Reduce and ReduceRight #45893

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
8513dbc
Updating type definitions for reduce and reduceRight and adding tests.
reubenrybnik Jul 5, 2020
9e20417
Adding defaults for V in memo iterators.
reubenrybnik Jul 5, 2020
9e65e3a
Updating a few tests to test constant memos more and omitted memos less.
reubenrybnik Jul 5, 2020
be6a66a
Updating reduce and reduceRight undefined memo overloads to allow a d…
reubenrybnik Jul 6, 2020
ed2dce7
Making a few test changes to better illustrate the ways that a union …
reubenrybnik Jul 6, 2020
1ed7dd6
Rewriting the overloads of reduce and reduceRight that take an option…
reubenrybnik Jul 7, 2020
df876e9
Removing the undefined type from the result for overloads that take a…
reubenrybnik Jul 7, 2020
9fe8bbb
Breaking up tests for multiple aliases by alias.
reubenrybnik Jul 7, 2020
d952cf3
Merge branch 'master' into underscore-tests-reduce-reduceRight
reubenrybnik Jul 7, 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
263 changes: 169 additions & 94 deletions types/underscore/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,14 +124,19 @@ declare module _ {

type IterateePropertyShorthand = string | number;

interface MemoIterator<T, TResult> {
(prev: TResult, curr: T, index: number, list: List<T>): TResult;
interface MemoIterator<T, TResult, V = List<T>> {
(prev: TResult, curr: T, index: number, list: V): TResult;
}

interface MemoObjectIterator<T, TResult> {
(prev: TResult, curr: T, key: string, list: Dictionary<T>): TResult;
interface MemoObjectIterator<T, TResult, V = Dictionary<T>> {
(prev: TResult, curr: T, key: string, object: V): TResult;
}

type MemoCollectionIterator<T, TResult, V> =
V extends List<T> ? MemoIterator<T, TResult, V>
: V extends Dictionary<T> ? MemoObjectIterator<T, TResult, V>
: never;

type TypeOfList<V> = V extends List<infer T> ? T : never;

type TypeOfDictionary<V> = V extends Dictionary<infer T> ? T : never;
Expand Down Expand Up @@ -234,76 +239,87 @@ declare module _ {
collect: UnderscoreStatic['map'];

/**
* Also known as inject and foldl, reduce boils down a list of values into a single value.
* Memo is the initial state of the reduction, and each successive step of it should be
* returned by iterator. The iterator is passed four arguments: the memo, then the value
* and index (or key) of the iteration, and finally a reference to the entire list.
* @param list Reduces the elements of this array.
* @param iterator Reduce iterator function for each element in `list`.
* @param memo Initial reduce state.
* @param context `this` object in `iterator`, optional.
* @return Reduced object result.
**/
reduce<T, TResult>(
list: _.List<T>,
iterator: _.MemoIterator<T, TResult>,
memo?: TResult,
context?: any): TResult;

reduce<T, TResult>(
list: _.Dictionary<T>,
iterator: _.MemoObjectIterator<T, TResult>,
memo?: TResult,
context?: any): TResult;
* Also known as inject and foldl, reduce boils down a collection of values into a
* single value. Memo is the initial state of the reduction, and each successive
* step of it should be returned by iteratee. The iteratee is passed four arguments:
* the memo, then the value and index (or key) of the iteration, and finally a reference
* to the entire collection.
*
* If no memo is passed to the initial invocation of reduce, the iteratee is not invoked
* on the first element of the collection. The first element is instead passed as the memo
* in the invocation of the iteratee on the next element in the collection.
* @param collection Reduces the elements of this collection.
* @param iteratee Reduce iteratee function for each element in `collection`.
* @param memo Initial reduce state or undefined to use the first collection item as initial state.
* @param context `this` object in `iteratee`, optional.
* @returns The reduced result.
**/
reduce<V extends List<any>, TResult>(
collection: V,
iteratee: MemoIterator<TypeOfList<V>, TResult, V>,
memo: TResult,
context?: any
): TResult;
reduce<V extends Dictionary<any>, TResult>(
collection: V,
iteratee: MemoObjectIterator<TypeOfDictionary<V>, TResult, V>,
memo: TResult,
context?: any
): TResult;
reduce<V extends List<any>, TResult = TypeOfList<V>>(
collection: V,
iteratee: MemoIterator<TypeOfList<V>, TResult | TypeOfList<V>, V>
): TResult | TypeOfList<V> | undefined;
reduce<V extends Dictionary<any>, TResult = TypeOfDictionary<V>>(
collection: V,
iteratee: MemoObjectIterator<TypeOfDictionary<V>, TResult | TypeOfDictionary<V>, V>
): TResult | TypeOfDictionary<V> | undefined;

/**
* @see _.reduce
**/
inject<T, TResult>(
list: _.List<T>,
iterator: _.MemoIterator<T, TResult>,
memo?: TResult,
context?: any): TResult;

inject<T, TResult>(
list: _.Dictionary<T>,
iterator: _.MemoObjectIterator<T, TResult>,
memo?: TResult,
context?: any): TResult;
* @see reduce
**/
inject: UnderscoreStatic['reduce'];

/**
* @see _.reduce
**/
foldl<T, TResult>(
list: _.Collection<T>,
iterator: _.MemoIterator<T, TResult>,
memo?: TResult,
context?: any): TResult;
* @see reduce
**/
foldl: UnderscoreStatic['reduce'];

/**
* The right-associative version of reduce. Delegates to the JavaScript 1.8 version of
* reduceRight, if it exists. `foldr` is not as useful in JavaScript as it would be in a
* language with lazy evaluation.
* @param list Reduces the elements of this array.
* @param iterator Reduce iterator function for each element in `list`.
* @param memo Initial reduce state.
* @param context `this` object in `iterator`, optional.
* @return Reduced object result.
**/
reduceRight<T, TResult>(
list: _.Collection<T>,
iterator: _.MemoIterator<T, TResult>,
memo?: TResult,
context?: any): TResult;
* The right-associative version of reduce.
*
* This is not as useful in JavaScript as it would be in a language with lazy evaluation.
* @param collection Reduces the elements of this array.
* @param iteratee Reduce iteratee function for each element in `collection`.
* @param memo Initial reduce state or undefined to use the first collection item as initial state.
* @param context `this` object in `iteratee`, optional.
* @returns The reduced result.
**/
reduceRight<V extends List<any>, TResult>(
collection: V,
iteratee: MemoIterator<TypeOfList<V>, TResult, V>,
memo: TResult,
context?: any
): TResult;
reduceRight<V extends Dictionary<any>, TResult>(
collection: V,
iteratee: MemoObjectIterator<TypeOfDictionary<V>, TResult, V>,
memo: TResult,
context?: any
): TResult;
reduceRight<V extends List<any>, TResult = TypeOfList<V>>(
collection: V,
iteratee: MemoIterator<TypeOfList<V>, TResult | TypeOfList<V>, V>
): TResult | TypeOfList<V> | undefined;
reduceRight<V extends Dictionary<any>, TResult = TypeOfDictionary<V>>(
collection: V,
iteratee: MemoObjectIterator<TypeOfDictionary<V>, TResult | TypeOfDictionary<V>, V>
): TResult | TypeOfDictionary<V> | undefined;

/**
* @see _.reduceRight
**/
foldr<T, TResult>(
list: _.Collection<T>,
iterator: _.MemoIterator<T, TResult>,
memo?: TResult,
context?: any): TResult;
* @see reduceRight
**/
foldr: UnderscoreStatic['reduceRight'];

/**
* Looks through each value in the list, returning the first one that passes a truth
Expand Down Expand Up @@ -4160,31 +4176,60 @@ declare module _ {
collect: Underscore<T, V>['map'];

/**
* Wrapped type `any[]`.
* @see _.reduce
**/
reduce<TResult>(iterator: _.MemoIterator<T, TResult>, memo?: TResult, context?: any): TResult;
* Also known as inject and foldl, reduce boils down a collection of wrapped values into a
* single value. Memo is the initial state of the reduction, and each successive
* step of it should be returned by iteratee. The iteratee is passed four arguments:
* the memo, then the value and index (or key) of the iteration, and finally a reference
* to the entire collection.
*
* If no memo is passed to the initial invocation of reduce, the iteratee is not invoked
* on the first element of the collection. The first element is instead passed as the memo
* in the invocation of the iteratee on the next element in the collection.
* @param iteratee Reduce iteratee function for each element in the wrapped collection.
* @param memo Initial reduce state or undefined to use the first collection item as initial state.
* @param context `this` object in `iteratee`, optional.
* @returns The reduced result.
**/
reduce<TResult>(iteratee: MemoCollectionIterator<T, TResult, V>,
memo: TResult,
context?: any
): TResult;
reduce<TResult = TypeOfCollection<V>>(
iteratee: MemoCollectionIterator<T, TResult | TypeOfCollection<V>, V>
): TResult | TypeOfCollection<V> | undefined;

/**
* @see _.reduce
* @see reduce
**/
inject<TResult>(iterator: _.MemoIterator<T, TResult>, memo?: TResult, context?: any): TResult;
inject: Underscore<T, V>['reduce'];

/**
* @see _.reduce
* @see reduce
**/
foldl<TResult>(iterator: _.MemoIterator<T, TResult>, memo?: TResult, context?: any): TResult;
foldl: Underscore<T, V>['reduce'];

/**
* Wrapped type `any[]`.
* @see _.reduceRight
**/
reduceRight<TResult>(iterator: _.MemoIterator<T, TResult>, memo?: TResult, context?: any): TResult;
* The right-associative version of reduce.
*
* This is not as useful in JavaScript as it would be in a language with lazy evaluation.
* @param iteratee Reduce iteratee function for each element in the wrapped collection.
* @param memo Initial reduce state or undefined to use the first collection item as initial state.
* @param context `this` object in `iteratee`, optional.
* @returns The reduced result.
**/
reduceRight<TResult>(
iteratee: MemoCollectionIterator<T, TResult, V>,
memo: TResult,
context?: any
): TResult;
reduceRight<TResult = TypeOfCollection<V>>(
iteratee: MemoCollectionIterator<T, TResult | TypeOfCollection<V>, V>
): TResult | TypeOfCollection<V> | undefined;

/**
* @see _.reduceRight
* @see reduceRight
**/
foldr<TResult>(iterator: _.MemoIterator<T, TResult>, memo?: TResult, context?: any): TResult;
foldr: Underscore<T, V>['reduceRight'];

/**
* Wrapped type `any[]`.
Expand Down Expand Up @@ -5111,31 +5156,61 @@ declare module _ {
collect: _Chain<T, V>['map'];

/**
* Wrapped type `any[]`.
* @see _.reduce
**/
reduce<TResult>(iterator: _.MemoIterator<T, TResult>, memo?: TResult, context?: any): _ChainSingle<TResult>;
* Also known as inject and foldl, reduce boils down a collection of wrapped values into a
* single value. Memo is the initial state of the reduction, and each successive
* step of it should be returned by iteratee. The iteratee is passed four arguments:
* the memo, then the value and index (or key) of the iteration, and finally a reference
* to the entire collection.
*
* If no memo is passed to the initial invocation of reduce, the iteratee is not invoked
* on the first element of the collection. The first element is instead passed as the memo
* in the invocation of the iteratee on the next element in the collection.
* @param iteratee Reduce iteratee function for each element in `list`.
* @param memo Initial reduce state or undefined to use the first collection item as initial state.
* @param context `this` object in `iteratee`, optional.
* @returns The reduced result in a chain wraper.
**/
reduce<TResult>(
iteratee: MemoCollectionIterator<T, TResult, V>,
memo: TResult,
context?: any
): _ChainSingle<TResult>;
reduce<TResult = TypeOfCollection<V>>(
iteratee: MemoCollectionIterator<T, TResult | TypeOfCollection<V>, V>
): _ChainSingle<TResult | TypeOfCollection<V> | undefined>;

/**
* @see _.reduce
* @see reduce
**/
inject<TResult>(iterator: _.MemoIterator<T, TResult>, memo?: TResult, context?: any): _ChainSingle<TResult>;
inject: _Chain<T, V>['reduce'];

/**
* @see _.reduce
* @see reduce
**/
foldl<TResult>(iterator: _.MemoIterator<T, TResult>, memo?: TResult, context?: any): _ChainSingle<TResult>;
foldl: _Chain<T, V>['reduce'];

/**
* Wrapped type `any[]`.
* @see _.reduceRight
**/
reduceRight<TResult>(iterator: _.MemoIterator<T, TResult>, memo?: TResult, context?: any): _ChainSingle<TResult>;
* The right-associative version of reduce.
*
* This is not as useful in JavaScript as it would be in a language with lazy evaluation.
* @param iteratee Reduce iteratee function for each element in the wrapped collection.
* @param memo Initial reduce state or undefined to use the first collection item as initial state.
* @param context `this` object in `iteratee`, optional.
* @returns The reduced result in a chain wrapper.
**/
reduceRight<TResult>(
iteratee: MemoCollectionIterator<T, TResult, V>,
memo: TResult,
context?: any
): _ChainSingle<TResult>;
reduceRight<TResult = TypeOfCollection<V>>(
iteratee: MemoCollectionIterator<T, TResult | TypeOfCollection<V>, V>
): _ChainSingle<TResult | TypeOfCollection<V> | undefined>;

/**
* @see _.reduceRight
* @see reduceRight
**/
foldr<TResult>(iterator: _.MemoIterator<T, TResult>, memo?: TResult, context?: any): _ChainSingle<TResult>;
foldr: _Chain<T, V>['reduceRight'];

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