Skip to content

[@types/underscore] Object Tests - MapObject, Pairs, and FindKey #46422

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 14 commits into from
Jul 31, 2020
Merged

[@types/underscore] Object Tests - MapObject, Pairs, and FindKey #46422

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
3530466
Updating type definitions for mapObject, pairs, and findKey and addin…
reubenrybnik Jul 29, 2020
ae409ac
Also updating Underscore.property to match the update to UnderscoreSt…
reubenrybnik Jul 29, 2020
2370a3c
Adding a few more tests.
reubenrybnik Jul 29, 2020
904f379
Combining Iteratee with ObjectIteratee and IterateeResult with Object…
reubenrybnik Jul 30, 2020
1ce562f
Improving the condition for choosing between Partial<T> and object.
reubenrybnik Jul 30, 2020
3fedc41
Fixing a test that breaks slightly with iteratee changes.
reubenrybnik Jul 30, 2020
ad45cae
Updating findKey to result in keyof V rather than just string.
reubenrybnik Jul 30, 2020
4c52b61
Updating the documentation of pairs to refer to a specific signature …
reubenrybnik Jul 30, 2020
425aadf
Dropping object and just going with Partial<T> because I realized tha…
reubenrybnik Jul 30, 2020
b3240f4
Handling the possibility of a property that is a type union as well a…
reubenrybnik Jul 31, 2020
f627f08
Switching constraints from dictionaries to collections since arrays a…
reubenrybnik Jul 31, 2020
6ab2e41
Adding a comment above the assignability test.
reubenrybnik Jul 31, 2020
4437241
Defaulting to a collection type of any for non-collections when evalu…
reubenrybnik Jul 31, 2020
1b03f4d
Using Extract instead of making up a new type and also using keyof V …
reubenrybnik Jul 31, 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
161 changes: 98 additions & 63 deletions types/underscore/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,15 +93,15 @@ declare module _ {
(value: T): boolean;
}

interface CollectionIterator<T extends TypeOfCollection<V>, TResult, V = Collection<T>> {
interface CollectionIterator<T extends TypeOfCollection<V, any>, TResult, V = Collection<T>> {
(element: T, key: CollectionKey<V>, collection: V): TResult;
}

interface ListIterator<T extends TypeOfList<V>, TResult, V = List<T>> extends CollectionIterator<T, TResult, V> { }

interface ObjectIterator<T extends TypeOfDictionary<V>, TResult, V = Dictionary<T>> extends CollectionIterator<T, TResult, V> { }
interface ObjectIterator<T extends TypeOfDictionary<V, any>, TResult, V = Dictionary<T>> extends CollectionIterator<T, TResult, V> { }

type Iteratee<V, R, T extends TypeOfCollection<V> = TypeOfCollection<V>> =
type Iteratee<V, R, T extends TypeOfCollection<V, any> = TypeOfCollection<V>> =
CollectionIterator<T, R, V> |
EnumerableKey |
EnumerableKey[] |
Expand All @@ -115,8 +115,8 @@ declare module _ {
type IterateeResult<I, T> =
I extends (...args: any[]) => infer R ? R
: I extends keyof T ? T[I]
: I extends EnumerableKey |EnumerableKey[] ? any
: I extends Partial<T> ? boolean
: I extends EnumerableKey | EnumerableKey[] ? any
: I extends object ? boolean
: I extends null | undefined ? T
: never;

Expand All @@ -135,12 +135,12 @@ declare module _ {
: V extends List<infer T> ? T
: never;

type TypeOfDictionary<V> =
type TypeOfDictionary<V, TDefault = never> =
V extends never ? any
: V extends Dictionary<infer T> ? T
: never;
: TDefault;

type TypeOfCollection<V> = TypeOfList<V> | TypeOfDictionary<V>;
type TypeOfCollection<V, TObjectDefault = never> = TypeOfList<V> | TypeOfDictionary<V, TObjectDefault>;

type ListItemOrSelf<T> = T extends List<infer TItem> ? TItem : T;

Expand Down Expand Up @@ -3436,36 +3436,27 @@ declare module _ {
values(object: any): any[];

/**
* Like map, but for objects. Transform the value of each property in turn.
* @param object The object to transform
* @param iteratee The function that transforms property values
* @param context The optional context (value of `this`) to bind to
* @return a new _.Dictionary of property values
*/
mapObject<T, U>(object: _.Dictionary<T>, iteratee: (val: T, key: string, object: _.Dictionary<T>) => U, context?: any): _.Dictionary<U>;

/**
* Like map, but for objects. Transform the value of each property in turn.
* @param object The object to transform
* @param iteratee The function that tranforms property values
* @param context The optional context (value of `this`) to bind to
*/
mapObject<T>(object: any, iteratee: (val: any, key: string, object: any) => T, context?: any): _.Dictionary<T>;

/**
* Like map, but for objects. Retrieves a property from each entry in the object, as if by _.property
* @param object The object to transform
* @param iteratee The property name to retrieve
* @param context The optional context (value of `this`) to bind to
* Like map, but for objects. Transform the value of each property in
* turn.
* @param object The object to transform.
* @param iteratee The iteratee to use to transform property values.
* @param context `this` object in `iteratee`, optional.
* @returns A new object with all of `object`'s property values
* transformed through `iteratee`.
*/
mapObject(object: any, iteratee: string, context?: any): _.Dictionary<any>;
mapObject<V extends object, I extends Iteratee<V, any, TypeOfCollection<V, any>>>(
object: V,
iteratee: I,
context?: any
): { [K in keyof V]: IterateeResult<I, V[K]> };

/**
* Convert an object into a list of [key, value] pairs.
* @param object Convert this object to a list of [key, value] pairs.
* @return List of [key, value] pairs on `object`.
**/
pairs(object: any): [string, any][];
* Converts `object` into a list of [key, value] pairs. The opposite
* of the single-argument signature of `_.object`.
* @param object The object to convert.
* @returns The list of [key, value] pairs from `object`.
**/
pairs<V extends object>(object: V): [Extract<keyof V, string>, TypeOfCollection<V, any>][];

/**
* Returns a copy of the object where the keys have become the values and the values the keys.
Expand Down Expand Up @@ -3515,12 +3506,19 @@ declare module _ {
...source: any[]): any;

/**
* Returns the first key on an object that passes a predicate test.
* @param obj the object to search in
* @param predicate Predicate function.
* @param context `this` object in `iterator`, optional.
*/
findKey<T>(obj: _.Dictionary<T>, predicate: _.ObjectIterator<T, boolean>, context?: any): string;
* Similar to `findIndex` but for keys in objects. Returns the key
* where the `iteratee` truth test passes or undefined.
* @param object The object to search.
* @param iteratee The truth test to apply.
* @param context `this` object in `iteratee`, optional.
* @returns The first element in `object` that passes the truth test or
* undefined if no elements pass.
*/
findKey<V extends object>(
object: V,
iteratee?: Iteratee<V, boolean, TypeOfCollection<V, any>>,
context?: any
): Extract<keyof V, string> | undefined;

/**
* Return a copy of the object, filtered to only have values for the whitelisted keys
Expand Down Expand Up @@ -3623,7 +3621,7 @@ declare module _ {
* @param key Property of the object.
* @return Function which accept an object an returns the value of key in that object.
**/
property(key: string | number | Array<string | number>): (object: object) => any;
property(key: string | number | Array<string | number>): (object: any) => any;

/**
* Returns a function that will itself return the value of a object key property.
Expand Down Expand Up @@ -4631,10 +4629,24 @@ declare module _ {
values(): T[];

/**
* Wrapped type `object`.
* @see _.pairs
**/
pairs(): [string, any][];
* Like map, but for objects. Transform the value of each property in
* turn.
* @param iteratee The iteratee to use to transform property values.
* @param context `this` object in `iteratee`, optional.
* @returns A new object with all of the wrapped object's property
* values transformed through `iteratee`.
*/
mapObject<I extends Iteratee<V, any, TypeOfCollection<V, any>>>(
iteratee: I,
context?: any
): { [K in keyof V]: IterateeResult<I, V[K]> };

/**
* Convert the wrapped object into a list of [key, value] pairs. The
* opposite of the single-argument signature of `_.object`.
* @returns The list of [key, value] pairs from the wrapped object.
**/
pairs(): [Extract<keyof V, string>, TypeOfCollection<V, any>][];

/**
* Wrapped type `object`.
Expand All @@ -4660,10 +4672,17 @@ declare module _ {
extend(...sources: any[]): any;

/**
* Wrapped type `object`.
* @see _.extend
**/
findKey(predicate: _.ObjectIterator<any, boolean>, context?: any): any
* Similar to `findIndex` but for keys in objects. Returns the key
* where the `iteratee` truth test passes or undefined.
* @param iteratee The truth test to apply.
* @param context `this` object in `iteratee`, optional.
* @returns The first element in the wrapped object that passes the
* truth test or undefined if no elements pass.
*/
findKey(
iteratee?: Iteratee<V, boolean, TypeOfCollection<V, any>>,
context?: any
): Extract<keyof V, string> | undefined;

/**
* Wrapped type `object`.
Expand Down Expand Up @@ -4727,7 +4746,7 @@ declare module _ {
* Wrapped type `string`.
* @see _.property
**/
property(): (object: object) => any;
property(): (object: any) => any;

/**
* Wrapped type `object`.
Expand Down Expand Up @@ -5674,16 +5693,25 @@ declare module _ {
values(): _Chain<any>;

/**
* Wrapped type `object`.
* @see _.mapObject
**/
mapObject(fn: _.ListIterator<T, any>): _Chain<T>;
* Like map, but for objects. Transform the value of each property in
* turn.
* @param iteratee The iteratee to use to transform property values.
* @param context `this` object in `iteratee`, optional.
* @returns A chain wrapper around a new object with all of the wrapped
* object's property values transformed through `iteratee`.
*/
mapObject<I extends Iteratee<V, any, TypeOfCollection<V, any>>>(
iteratee: I,
context?: any
): _Chain<IterateeResult<I, TypeOfCollection<V, any>>, { [K in keyof V]: IterateeResult<I, V[K]> }>;

/**
* Wrapped type `object`.
* @see _.pairs
**/
pairs(): _Chain<[string, any]>;
* Convert the wrapped object into a list of [key, value] pairs. The
* opposite of the single-argument signature of `_.object`.
* @returns A chain wrapper around the list of [key, value] pairs from
* the wrapped object.
**/
pairs(): _Chain<[Extract<keyof V, string>, TypeOfCollection<V, any>], [Extract<keyof V, string>, TypeOfCollection<V, any>][]>;

/**
* Wrapped type `object`.
Expand All @@ -5709,10 +5737,17 @@ declare module _ {
extend(...sources: any[]): _Chain<T>;

/**
* Wrapped type `object`.
* @see _.extend
**/
findKey(predicate: _.ObjectIterator<any, boolean>, context?: any): _Chain<T>
* Similar to `findIndex` but for keys in objects. Returns the key
* where the `iteratee` truth test passes or undefined.
* @param iteratee The truth test to apply.
* @param context `this` object in `iteratee`, optional.
* @returns The first element in the wrapped object that passes the
* truth test or undefined if no elements pass.
*/
findKey(
iteratee?: Iteratee<V, boolean, TypeOfCollection<V, any>>,
context?: any
): _ChainSingle<Extract<keyof V, string> | undefined>;

/**
* Wrapped type `object`.
Expand Down
Loading