@bleedingdev/modern-js-utils 3.9.0-ultramodern.9 → 3.9.3-ultramodern.2

package/dist/compiled/lodash/common/array.d.ts

@@ -1,4 +1,12 @@
 import _ = require("../index");
+
+// Helper types to reject readonly arrays
+type _Eq<T, U> = (<X>() => X extends T ? 1 : 2) extends (<X>() => X extends U ? 1 : 2) ? true : false
+type _IsWritable<T> = _Eq<{ [K in keyof T]: T[K] }, { -readonly [K in keyof T]: T[K] }>
+type RejectReadonly<T extends _.MutableList<unknown>> = _IsWritable<T> extends true ? T : never
+
+export {}
+
 declare module "../index" {
     interface LoDashStatic {
         /**
@@ -25,16 +33,17 @@ declare module "../index" {
     }
     interface LoDashStatic {
         /**
-         * Creates an array with all falsey values removed. The values false, null, 0, "", undefined, and NaN are
+         * Creates an array with all falsey values removed. The values false, null, 0, 0n, "", undefined, and NaN are
          * falsey.
          *
          * @param array The array to compact.
          * @return Returns the new array of filtered values.
          */
-        compact<T>(array: List<T | null | undefined | false | "" | 0> | null | undefined): T[];
+        compact<T>(array: List<T | Falsey> | null | undefined): T[];
     }
 
-    type Truthy<T> = T extends null | undefined | false | "" | 0 ? never : T;
+    type Falsey = null | undefined | false | "" | 0 | 0n;
+    type Truthy<T> = T extends Falsey ? never : T;
     interface Collection<T> {
         /**
          * @see _.compact
@@ -341,7 +350,7 @@ declare module "../index" {
         /**
          * @see _.fill
          */
-        fill<T>(array: List<any> | null | undefined, value: T): List<T>;
+        fill<T, AnyList extends MutableList<any>>(array: RejectReadonly<AnyList> | null | undefined, value: T): List<T>;
         /**
          * @see _.fill
          */
@@ -349,7 +358,7 @@ declare module "../index" {
         /**
          * @see _.fill
          */
-        fill<T, U>(array: List<U> | null | undefined, value: T, start?: number, end?: number): List<T | U>;
+        fill<T, UList extends MutableList<any>>(array: RejectReadonly<UList> | null | undefined, value: T, start?: number, end?: number): List<T | UList[0]>;
     }
     interface Collection<T> {
         /**
@@ -573,6 +582,7 @@ declare module "../index" {
          * @param array The array to query.
          * @return Returns the first element of array.
          */
+        head<T>(array: readonly [T, ...unknown[]]): T;
         head<T>(array: List<T> | null | undefined): T | undefined;
     }
     interface String {
@@ -758,39 +768,39 @@ declare module "../index" {
          * _.intersectionWith(objects, others, _.isEqual);
          * // => [{ 'x': 1, 'y': 2 }]
          */
-        intersectionWith<T1, T2>(array: List<T1> | null | undefined, values: List<T2>, comparator: Comparator2<T1, T2>): T1[];
+        intersectionWith<T1, T2>(array: List<T1> | null | undefined, values: List<T2>, comparator: Comparator2<T1, T1 | T2>): T1[];
         /**
          * @see _.intersectionWith
          */
-        intersectionWith<T1, T2, T3>(array: List<T1> | null | undefined, values1: List<T2>, values2: List<T3>, comparator: Comparator2<T1, T2 | T3>): T1[];
+        intersectionWith<T1, T2, T3>(array: List<T1> | null | undefined, values1: List<T2>, values2: List<T3>, comparator: Comparator2<T1, T1 | T2 | T3>): T1[];
         /**
          * @see _.intersectionWith
          */
-        intersectionWith<T1, T2, T3, T4>(array: List<T1> | null | undefined, values1: List<T2>, values2: List<T3>, ...values: Array<List<T4> | Comparator2<T1, T2 | T3 | T4>>): T1[];
+        intersectionWith<T1, T2, T3, T4>(array: List<T1> | null | undefined, values1: List<T2>, values2: List<T3>, ...values: Array<List<T4> | Comparator2<T1, T1 | T2 | T3 | T4>>): T1[];
         /**
          * @see _.intersectionWith
          */
-        intersectionWith<T>(array?: List<T> | null, ...values: Array<List<T> | Comparator2<T, never>>): T[];
+        intersectionWith<T>(array?: List<T> | null, ...values: Array<List<T> | Comparator<T>>): T[];
     }
     interface Collection<T> {
         /**
          * @see _.intersectionWith
          */
-        intersectionWith<T2>(values: List<T2>, comparator: Comparator2<T, T2>): Collection<T>;
+        intersectionWith<T2>(values: List<T2>, comparator: Comparator2<T, T | T2>): Collection<T>;
         /**
          * @see _.intersectionWith
          */
-        intersectionWith(...values: Array<List<unknown> | Comparator2<T,  never>>): Collection<T>;
+        intersectionWith(...values: Array<List<unknown> | Comparator<T>>): Collection<T>;
     }
     interface CollectionChain<T> {
         /**
          * @see _.intersectionWith
          */
-        intersectionWith<T2>(values: List<T2>, comparator: Comparator2<T, T2>): CollectionChain<T>;
+        intersectionWith<T2>(values: List<T2>, comparator: Comparator2<T, T | T2>): CollectionChain<T>;
         /**
          * @see _.intersectionWith
          */
-        intersectionWith(...values: Array<List<unknown> | Comparator2<T,  never>>): CollectionChain<T>;
+        intersectionWith(...values: Array<List<unknown> | Comparator<T>>): CollectionChain<T>;
     }
     interface LoDashStatic {
         /**
@@ -839,6 +849,7 @@ declare module "../index" {
          * @param array The array to query.
          * @return Returns the last element of array.
          */
+        last<T>(array: readonly [...unknown[], T]): T;
         last<T>(array: List<T> | null | undefined): T | undefined;
     }
     interface Collection<T> {
@@ -930,7 +941,7 @@ declare module "../index" {
         /**
          * @see _.pull
          */
-        pull<T>(array: List<T>, ...values: T[]): List<T>;
+        pull<TList extends MutableList<any>>(array: RejectReadonly<TList>, ...values: TList[0][]): TList;
     }
     interface Collection<T> {
         /**
@@ -966,7 +977,7 @@ declare module "../index" {
         /**
          * @see _.pullAll
          */
-        pullAll<T>(array: List<T>, values?: List<T>): List<T>;
+        pullAll<TList extends MutableList<any>>(array: RejectReadonly<TList>, values?: List<TList[0]>): TList;
     }
     interface Collection<T> {
         /**
@@ -1005,7 +1016,7 @@ declare module "../index" {
         /**
          * @see _.pullAllBy
          */
-        pullAllBy<T>(array: List<T>, values?: List<T>, iteratee?: ValueIteratee<T>): List<T>;
+        pullAllBy<TList extends MutableList<any>>(array: RejectReadonly<TList>, values?: List<TList[0]>, iteratee?: ValueIteratee<TList[0]>): TList;
         /**
          * @see _.pullAllBy
          */
@@ -1013,7 +1024,7 @@ declare module "../index" {
         /**
          * @see _.pullAllBy
          */
-        pullAllBy<T1, T2>(array: List<T1>, values: List<T2>, iteratee: ValueIteratee<T1 | T2>): List<T1>;
+        pullAllBy<T1List extends MutableList<any>, T2>(array: RejectReadonly<T1List>, values: List<T2>, iteratee: ValueIteratee<T1List[0] | T2>): T1List;
     }
     interface Collection<T> {
         /**
@@ -1052,7 +1063,7 @@ declare module "../index" {
         /**
          * @see _.pullAllWith
          */
-        pullAllWith<T>(array: List<T>, values?: List<T>, comparator?: Comparator<T>): List<T>;
+        pullAllWith<TList extends MutableList<any>>(array: RejectReadonly<TList>, values?: List<TList[0]>, comparator?: Comparator<TList[0]>): TList;
         /**
          * @see _.pullAllWith
          */
@@ -1060,7 +1071,7 @@ declare module "../index" {
         /**
          * @see _.pullAllWith
          */
-        pullAllWith<T1, T2>(array: List<T1>, values: List<T2>, comparator: Comparator2<T1, T2>): List<T1>;
+        pullAllWith<T1List extends MutableList<any>, T2>(array: RejectReadonly<T1List>, values: List<T2>, comparator: Comparator2<T1List[0], T2>): T1List;
     }
     interface Collection<T> {
         /**
@@ -1089,7 +1100,7 @@ declare module "../index" {
         /**
          * @see _.pullAt
          */
-        pullAt<T>(array: List<T>, ...indexes: Array<Many<number>>): List<T>;
+        pullAt<TList extends MutableList<any>>(array: RejectReadonly<TList>, ...indexes: Array<Many<number>>): TList;
     }
     interface Collection<T> {
         /**
@@ -1114,7 +1125,7 @@ declare module "../index" {
          * @param predicate The function invoked per iteration.
          * @return Returns the new array of removed elements.
          */
-        remove<T>(array: List<T>, predicate?: ListIteratee<T>): T[];
+        remove<TList extends MutableList<any>>(array: RejectReadonly<TList>, predicate?: ListIteratee<TList[0]>): TList[0][];
     }
     interface Collection<T> {
         /**
@@ -1148,7 +1159,7 @@ declare module "../index" {
          * console.log(array);
          * // => [3, 2, 1]
          */
-        reverse<TList extends List<any>>(array: TList): TList;
+        reverse<TList extends MutableList<any>>(array: RejectReadonly<TList>): TList;
     }
     interface LoDashStatic {
         /**
@@ -1449,6 +1460,7 @@ declare module "../index" {
          * @param array The array to query.
          * @return Returns the slice of array.
          */
+        tail<T extends unknown[]>(array: readonly [unknown, ...T]): T;
         tail<T>(array: List<T> | null | undefined): T[];
     }
     interface Collection<T> {
@@ -1772,6 +1784,28 @@ declare module "../index" {
          * @param array The array of grouped elements to process.
          * @return Returns the new array of regrouped elements.
          */
+        unzip<T1, T2>(array: Array<[T1, T2]>): [T1[], T2[]];
+        /**
+         * @see _.unzip
+         */
+        unzip<T1, T2, T3>(
+            array: Array<[T1, T2, T3]>,
+        ): [T1[], T2[], T3[]];
+        /**
+         * @see _.unzip
+         */
+        unzip<T1, T2, T3, T4>(
+            array: Array<[T1, T2, T3, T4]>,
+        ): [T1[], T2[], T3[], T4[]];
+        /**
+         * @see _.unzip
+         */
+        unzip<T1, T2, T3, T4, T5>(
+            array: Array<[T1, T2, T3, T4, T5]>,
+        ): [T1[], T2[], T3[], T4[], T5[]];
+        /**
+         * @see _.unzip
+         */
         unzip<T>(array: T[][] | List<List<T>> | null | undefined): T[][];
     }
     interface Collection<T> {

package/dist/compiled/lodash/common/collection.d.ts

@@ -1153,6 +1153,10 @@ declare module "../index" {
          * @param iteratee The function invoked per iteration.
          * @return Returns the new mapped array.
          */
+        map<T extends readonly [unknown, ...unknown[]], TResult>(collection: T, iteratee: TupleIterator<T, TResult>): { [K in keyof T]: TResult };
+        /**
+         * @see _.map
+         */
         map<T, TResult>(collection: T[] | null | undefined, iteratee: ArrayIterator<T, TResult>): TResult[];
         /**
          * @see _.map
@@ -1309,7 +1313,7 @@ declare module "../index" {
          * @param collection The collection to iterate over.
          * @param [iteratees=[_.identity]] The iteratees to sort by.
          * @param [orders] The sort orders of `iteratees`.
-         * @param- {Object} [guard] Enables use as an iteratee for functions like `_.reduce`.
+         * @param [guard] Enables use as an iteratee for functions like `_.reduce`.
          * @returns Returns the new sorted array.
          * @example
          *
@@ -1645,6 +1649,10 @@ declare module "../index" {
          * @param collection The collection to sample.
          * @return Returns the random element.
          */
+        sample<T>(collection: readonly [T, ...T[]]): T;
+        /**
+         * @see _.sample
+         */
         sample<T>(collection: Dictionary<T> | NumericDictionary<T> | null | undefined): T | undefined;
         /**
          * @see _.sample

package/dist/compiled/lodash/common/common.d.ts

@@ -1,14 +1,15 @@
 import _ = require("../index");
-// tslint:disable-next-line:strict-export-declare-modifiers
+// eslint-disable-next-line @definitelytyped/strict-export-declare-modifiers
 type GlobalPartial<T> = Partial<T>;
+export const uniqueSymbol: unique symbol;
 declare module "../index" {
     type Omit<T, K extends keyof any> = Pick<T, Exclude<keyof T, K>>;
     type PartialObject<T> = GlobalPartial<T>;
-    type Many<T> = T | ReadonlyArray<T>;
+    type Many<T> = T | readonly T[];
     type ImpChain<T> =
         T extends { __trapAny: any } ? Collection<any> & Function<any> & Object<any> & Primitive<any> & String :
         T extends null | undefined ? never :
-        T extends string | null | undefined ? String :
+        T extends string ? String<T> :
         T extends (...args: any) => any ? Function<T> :
         T extends List<infer U> | null | undefined ? Collection<U> :
         T extends object | null | undefined ? Object<T> :
@@ -16,8 +17,7 @@ declare module "../index" {
     type ExpChain<T> =
         T extends { __trapAny: any } ? CollectionChain<any> & FunctionChain<any> & ObjectChain<any> & PrimitiveChain<any> & StringChain :
         T extends null | undefined ? never :
-        T extends string ? StringChain :
-        T extends string | null | undefined ? StringNullableChain :
+        T extends string ? StringChain<T> :
         T extends (...args: any) => any ? FunctionChain<T> :
         T extends List<infer U> | null | undefined ? CollectionChain<U> :
         T extends object | null | undefined ? ObjectChain<T> :
@@ -92,6 +92,7 @@ declare module "../index" {
         * upperFirst, value, and words.
         **/
         <TrapAny extends { __trapAny: any }>(value: TrapAny): Collection<any> & Function<any> & Object<any> & Primitive<any> & String;
+        <T extends string>(value: T): String<T>;
         <T extends null | undefined>(value: T): Primitive<T>;
         (value: string | null | undefined): String;
         <T extends (...args: any) => any>(value: T): Function<T>;
@@ -116,11 +117,11 @@ declare module "../index" {
         /**
         * The "escape" delimiter.
         **/
-        escape?: RegExp | undefined;
+        escape?: RegExp | null | undefined;
         /**
         * The "evaluate" delimiter.
         **/
-        evaluate?: RegExp | undefined;
+        evaluate?: RegExp | null | undefined;
         /**
         * An object to import into the template as local variables.
         */
@@ -128,7 +129,7 @@ declare module "../index" {
         /**
         * The "interpolate" delimiter.
         */
-        interpolate?: RegExp | undefined;
+        interpolate?: RegExp | null | undefined;
         /**
         * Used to reference the data object in the template text.
         */
@@ -189,7 +190,7 @@ declare module "../index" {
     }
     interface Function<T extends (...args: any) => any> extends LoDashImplicitWrapper<T> {
     }
-    interface String extends LoDashImplicitWrapper<string> {
+    interface String<T extends string = string> extends LoDashImplicitWrapper<T> {
     }
     interface Object<T> extends LoDashImplicitWrapper<T> {
     }
@@ -199,7 +200,7 @@ declare module "../index" {
     }
     interface FunctionChain<T extends (...args: any) => any> extends LoDashExplicitWrapper<T> {
     }
-    interface StringChain extends LoDashExplicitWrapper<string> {
+    interface StringChain<T extends string = string> extends LoDashExplicitWrapper<T> {
     }
     interface StringNullableChain extends LoDashExplicitWrapper<string | undefined> {
     }
@@ -212,6 +213,7 @@ declare module "../index" {
     type NotVoid = unknown;
     type IterateeShorthand<T> = PropertyName | [PropertyName, any] | PartialShallow<T>;
     type ArrayIterator<T, TResult> = (value: T, index: number, collection: T[]) => TResult;
+    type TupleIterator<T extends readonly unknown[], TResult> = (value: T[number], index: StringToNumber<keyof T>, collection: T) => TResult;
     type ListIterator<T, TResult> = (value: T, index: number, collection: List<T>) => TResult;
     type ListIteratee<T> = ListIterator<T, NotVoid> | IterateeShorthand<T>;
     type ListIterateeCustom<T, TResult> = ListIterator<T, TResult> | IterateeShorthand<T>;
@@ -244,6 +246,10 @@ declare module "../index" {
     type PropertyPath = Many<PropertyName>;
     /** Common interface between Arrays and jQuery objects */
     type List<T> = ArrayLike<T>;
+    interface MutableList<T> { // Needed since ArrayLike is readonly
+        length: number;
+        [k: number]: T;
+    }
     interface Dictionary<T> {
         [index: string]: T;
     }
@@ -257,6 +263,7 @@ declare module "../index" {
     type PartialShallow<T> = {
         [P in keyof T]?: T[P] extends object ? object : T[P]
     };
+    type StringToNumber<T> = T extends `${infer N extends number}` ? N : never;
     // For backwards compatibility
     type LoDashImplicitArrayWrapper<T> = LoDashImplicitWrapper<T[]>;
     type LoDashImplicitNillableArrayWrapper<T> = LoDashImplicitWrapper<T[] | null | undefined>;

package/dist/compiled/lodash/common/function.d.ts

@@ -655,7 +655,6 @@ declare module "../index" {
         <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, plc1: __, plc2: __, arg3: T3): Function3<T1, T2, T4, R>;
         <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg1: T1, plc2: __, arg3: T3): Function2<T2, T4, R>;
         <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, plc1: __, arg2: T2, arg3: T3): Function2<T1, T4, R>;
-        <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg1: T1, arg2: T2, arg3: T3): Function1<T4, R>;
         <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, plc1: __, plc2: __, plc3: __, arg4: T4): Function3<T1, T2, T3, R>;
         <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg1: T1, plc2: __, plc3: __, arg4: T4): Function2<T2, T3, R>;
         <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, plc1: __, arg2: T2, plc3: __, arg4: T4): Function2<T1, T3, R>;
@@ -1355,6 +1354,7 @@ declare module "../index" {
          */
         trailing?: boolean | undefined;
     }
+    type ThrottleSettingsLeading = (ThrottleSettings & { leading: true }) | Omit<ThrottleSettings, 'leading'>
     interface LoDashStatic {
         /**
          * Creates a throttled function that only invokes func at most once per every wait milliseconds. The throttled
@@ -1372,12 +1372,17 @@ declare module "../index" {
          * @param options.trailing Specify invoking on the trailing edge of the timeout.
          * @return Returns the new throttled function.
          */
+        throttle<T extends (...args: any) => any>(func: T, wait?: number, options?: ThrottleSettingsLeading): DebouncedFuncLeading<T>;
         throttle<T extends (...args: any) => any>(func: T, wait?: number, options?: ThrottleSettings): DebouncedFunc<T>;
     }
     interface Function<T extends (...args: any) => any> {
         /**
          * @see _.throttle
          */
+        throttle(
+            wait?: number,
+            options?: ThrottleSettingsLeading
+        ): T extends (...args: any[]) => any ? Function<DebouncedFuncLeading<T>> : never;
         throttle(
             wait?: number,
             options?: ThrottleSettings
@@ -1387,6 +1392,10 @@ declare module "../index" {
         /**
          * @see _.throttle
          */
+        throttle(
+            wait?: number,
+            options?: ThrottleSettingsLeading
+        ): T extends (...args: any[]) => any ? FunctionChain<DebouncedFuncLeading<T>> : never;
         throttle(
             wait?: number,
             options?: ThrottleSettings

package/dist/compiled/lodash/common/lang.d.ts

@@ -1,5 +1,5 @@
 import _ = require("../index");
-// tslint:disable-next-line:strict-export-declare-modifiers
+// eslint-disable-next-line @definitelytyped/strict-export-declare-modifiers, @typescript-eslint/no-unsafe-function-type
 type GlobalFunction = Function;
 declare module "../index" {
     type FunctionBase = GlobalFunction;
@@ -342,10 +342,6 @@ declare module "../index" {
          * @return Returns true if value is correctly classified, else false.
          */
         isArray(value?: any): value is any[];
-        /**
-         * @see _.isArray
-         */
-        isArray<T>(value?: any): value is any[];
     }
     interface LoDashImplicitWrapper<TValue> {
         /**
@@ -561,6 +557,8 @@ declare module "../index" {
         isElement(): PrimitiveChain<boolean>;
     }
 
+    type EmptyObject<T> = { [K in keyof T]?: never };
+    type EmptyObjectOf<T> = EmptyObject<T> extends T ? EmptyObject<T> : never;
     interface LoDashStatic {
         /**
          * Checks if value is empty. A value is considered empty unless it’s an arguments object, array, string, or
@@ -569,6 +567,11 @@ declare module "../index" {
          * @param value The value to inspect.
          * @return Returns true if value is empty, else false.
          */
+        isEmpty<T extends { __trapAny: any }>(value?: T): boolean;
+        isEmpty(value: string): value is '';
+        isEmpty(value: Map<any, any> | Set<any> | List<any> | null | undefined): boolean;
+        isEmpty(value: object): boolean;
+        isEmpty<T extends object>(value: T | null | undefined): value is EmptyObjectOf<T> | null | undefined;
         isEmpty(value?: any): boolean;
     }
     interface LoDashImplicitWrapper<TValue> {

package/dist/compiled/lodash/common/math.d.ts

@@ -101,6 +101,7 @@ declare module "../index" {
           * @param array The array to iterate over.
           * @returns Returns the maximum value.
          */
+        max<T>(collection: readonly [T, ...T[]]): T;
         max<T>(collection: List<T> | null | undefined): T | undefined;
     }
     interface Collection<T> {
@@ -130,7 +131,7 @@ declare module "../index" {
          *
          * var objects = [{ 'n': 1 }, { 'n': 2 }];
          *
-         * _.maxBy(objects, function(o) { return o.a; });
+         * _.maxBy(objects, function(o) { return o.n; });
          * // => { 'n': 2 }
          *
          * // using the `_.property` iteratee shorthand
@@ -216,6 +217,7 @@ declare module "../index" {
          * @param array The array to iterate over.
          * @returns Returns the minimum value.
          */
+        min<T>(collection: readonly [T, ...T[]]): T;
         min<T>(collection: List<T> | null | undefined): T | undefined;
     }
     interface Collection<T> {