@types/lodash 4.14.87 → 4.14.91

lodash/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for Lo-Dash (http://lodash.com/).
 Files were exported from https://www.github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/lodash
 
 Additional Details
- * Last updated: Sun, 03 Dec 2017 16:26:41 GMT
+ * Last updated: Fri, 15 Dec 2017 01:17:38 GMT
  * Dependencies: none
  * Global values: _
 

lodash/index.d.ts

@@ -3954,6 +3954,10 @@ declare namespace _ {
             arrays3: List<T> | null | undefined,
             arrays4: List<T> | null | undefined,
             arrays5: List<T> | null | undefined,
+            iteratee: (value1: T, value2: T, value3: T, value4: T, value5: T) => TResult
+        ): TResult[];
+
+        zipWith<T, TResult>(
             ...iteratee: Array<((...group: T[]) => TResult) | List<T> | null | undefined>
         ): TResult[];
     }
@@ -6263,7 +6267,7 @@ declare namespace _ {
         partition<T>(
             collection: List<T> | null | undefined,
             callback: ValueIteratee<T>
-        ): T[][];
+        ): [T[], T[]];
 
         /**
          * @see _.partition
@@ -6271,7 +6275,7 @@ declare namespace _ {
         partition<T extends object>(
             collection: T | null | undefined,
             callback: ValueIteratee<T[keyof T]>
-        ): Array<Array<T[keyof T]>>;
+        ): [Array<T[keyof T]>, Array<T[keyof T]>];
     }
 
     interface LoDashImplicitWrapper<TValue> {
@@ -6281,7 +6285,7 @@ declare namespace _ {
         partition<T>(
             this: LoDashImplicitWrapper<List<T> | null | undefined>,
             callback: ValueIteratee<T>
-        ): LoDashImplicitWrapper<T[][]>;
+        ): LoDashImplicitWrapper<[T[], T[]]>;
 
         /**
          * @see _.partition
@@ -6289,7 +6293,7 @@ declare namespace _ {
         partition<T>(
             this: LoDashImplicitWrapper<T | null | undefined>,
             callback: ValueIteratee<T[keyof T]>
-        ): LoDashImplicitWrapper<Array<Array<T[keyof T]>>>;
+        ): LoDashImplicitWrapper<[Array<T[keyof T]>, Array<T[keyof T]>]>;
     }
 
     interface LoDashExplicitWrapper<TValue> {
@@ -6299,7 +6303,7 @@ declare namespace _ {
         partition<T>(
             this: LoDashExplicitWrapper<List<T> | null | undefined>,
             callback: ValueIteratee<T>
-        ): LoDashExplicitWrapper<T[][]>;
+        ): LoDashExplicitWrapper<[T[], T[]]>;
 
         /**
          * @see _.partition
@@ -6307,7 +6311,7 @@ declare namespace _ {
         partition<T>(
             this: LoDashExplicitWrapper<T | null | undefined>,
             callback: ValueIteratee<T[keyof T]>
-        ): LoDashExplicitWrapper<Array<Array<T[keyof T]>>>;
+        ): LoDashExplicitWrapper<[Array<T[keyof T]>, Array<T[keyof T]>]>;
     }
 
     //_.reduce
@@ -11585,6 +11589,10 @@ declare namespace _ {
             lower: number,
             upper: number
         ): number;
+        clamp(
+            number: number,
+            upper: number
+        ): number;
     }
 
     interface LoDashImplicitWrapper<TValue> {
@@ -11595,6 +11603,9 @@ declare namespace _ {
             lower: number,
             upper: number
         ): number;
+        clamp(
+            upper: number
+        ): number;
     }
 
     interface LoDashExplicitWrapper<TValue> {
@@ -11605,6 +11616,9 @@ declare namespace _ {
             lower: number,
             upper: number
         ): LoDashExplicitWrapper<number>;
+        clamp(
+            upper: number
+        ): LoDashExplicitWrapper<number>;
     }
 
     //_.inRange
@@ -11658,8 +11672,6 @@ declare namespace _ {
          * @return Returns the random number.
          */
         random(
-            min?: number,
-            max?: number,
             floating?: boolean
         ): number;
 
@@ -11667,44 +11679,64 @@ declare namespace _ {
          * @see _.random
          */
         random(
-            min?: number,
+            max: number,
             floating?: boolean
         ): number;
 
         /**
          * @see _.random
          */
-        random(floating?: boolean): number;
-    }
+        random(
+            min: number,
+            max: number,
+            floating?: boolean
+        ): number;
 
-    interface LoDashImplicitWrapper<TValue> {
         /**
-         * @see _.random
+         * Produces a random number between min and max (inclusive). If only one argument is provided a number between
+         * 0 and the given number is returned. If floating is true, or either min or max are floats, a floating-point
+         * number is returned instead of an integer.
+         *
+         * @param min The minimum possible value.
+         * @param index Not used in this overload.
+         * @param guard Enables use as an iteratee for methods like _.map. You should not pass this parameter directly in your code.
+         * @return Returns the random number.
          */
         random(
-            max?: number,
-            floating?: boolean
+            min: number,
+            index: string | number,
+            guard: object
         ): number;
+    }
 
+    interface LoDashImplicitWrapper<TValue> {
         /**
          * @see _.random
          */
         random(floating?: boolean): number;
-    }
 
-    interface LoDashExplicitWrapper<TValue> {
         /**
          * @see _.random
          */
         random(
-            max?: number,
+            max: number,
             floating?: boolean
-        ): LoDashExplicitWrapper<number>;
+        ): number;
+    }
 
+    interface LoDashExplicitWrapper<TValue> {
         /**
          * @see _.random
          */
         random(floating?: boolean): LoDashExplicitWrapper<number>;
+
+        /**
+         * @see _.random
+         */
+        random(
+            max: number,
+            floating?: boolean
+        ): LoDashExplicitWrapper<number>;
     }
 
     /**********
@@ -14394,7 +14426,7 @@ declare namespace _ {
          * // => { 'a': 1, 'c': 3 }
          */
         pick<T extends object, U extends keyof T>(
-            object: T | null | undefined,
+            object: T,
              ...props: Array<Many<U>>
         ): Pick<T, U>;
 
@@ -14412,7 +14444,7 @@ declare namespace _ {
          * @see _.pick
          */
         pick<T extends object, U extends keyof T>(
-            this: LoDashImplicitWrapper<T | null | undefined>,
+            this: LoDashImplicitWrapper<T>,
             ...props: Array<Many<U>>
         ): LoDashImplicitWrapper<Pick<T, U>>;
 
@@ -14430,7 +14462,7 @@ declare namespace _ {
          * @see _.pick
          */
         pick<T extends object, U extends keyof T>(
-            this: LoDashExplicitWrapper<T | null | undefined>,
+            this: LoDashExplicitWrapper<T>,
             ...props: Array<Many<U>>
         ): LoDashExplicitWrapper<Pick<T, U>>;
 
@@ -15667,6 +15699,9 @@ declare namespace _ {
          *
          * Note: This method is based on String#split.
          *
+         * @param string The string to trim.
+         * @param separator The separator pattern to split by.
+         * @param limit The length to truncate results to.
          * @return Returns the new array of string segments.
          */
         split(
@@ -15674,6 +15709,22 @@ declare namespace _ {
             separator?: RegExp|string,
             limit?: number
         ): string[];
+
+        /**
+         * Splits string by separator.
+         *
+         * Note: This method is based on String#split.
+         *
+         * @param string The string to trim.
+         * @param index Not used in this overload.
+         * @param guard Enables use as an iteratee for methods like _.map. You should not pass this parameter directly in your code.
+         * @return Returns the new array of string segments.
+         */
+        split(
+            string: string,
+            index: string | number,
+            guard: object
+        ): string[];
     }
 
     interface LoDashImplicitWrapper<TValue> {
@@ -15881,6 +15932,20 @@ declare namespace _ {
             string?: string,
             chars?: string
         ): string;
+
+        /**
+         * Removes leading and trailing whitespace or specified characters from string.
+         *
+         * @param string The string to trim.
+         * @param index Not used in this overload.
+         * @param guard Enables use as an iteratee for methods like _.map. You should not pass this parameter directly in your code.
+         * @return Returns the trimmed string.
+         */
+        trim(
+            string: string,
+            index: string | number,
+            guard: object
+        ): string;
     }
 
     interface LoDashImplicitWrapper<TValue> {
@@ -15910,6 +15975,20 @@ declare namespace _ {
             string?: string,
             chars?: string
         ): string;
+
+        /**
+         * Removes trailing whitespace or specified characters from string.
+         *
+         * @param string The string to trim.
+         * @param index Not used in this overload.
+         * @param guard Enables use as an iteratee for methods like _.map. You should not pass this parameter directly in your code.
+         * @return Returns the trimmed string.
+         */
+        trimEnd(
+            string: string,
+            index: string | number,
+            guard: object
+        ): string;
     }
 
     interface LoDashImplicitWrapper<TValue> {
@@ -15939,6 +16018,20 @@ declare namespace _ {
             string?: string,
             chars?: string
         ): string;
+
+        /**
+         * Removes leading whitespace or specified characters from string.
+         *
+         * @param string The string to trim.
+         * @param index Not used in this overload.
+         * @param guard Enables use as an iteratee for methods like _.map. You should not pass this parameter directly in your code.
+         * @return Returns the trimmed string.
+         */
+        trimStart(
+            string: string,
+            index: string | number,
+            guard: object
+        ): string;
     }
 
     interface LoDashImplicitWrapper<TValue> {
@@ -16086,6 +16179,20 @@ declare namespace _ {
             string?: string,
             pattern?: string|RegExp
         ): string[];
+
+        /**
+         * Splits `string` into an array of its words.
+         *
+         * @param string The string to inspect.
+         * @param index Not used in this overload.
+         * @param guard Enables use as an iteratee for methods like _.map. You should not pass this parameter directly in your code.
+         * @return Returns the words of `string`.
+         */
+        words(
+            string: string,
+            index: string | number,
+            guard: object
+        ): string[];
     }
 
     interface LoDashImplicitWrapper<TValue> {
@@ -16746,6 +16853,22 @@ declare namespace _ {
             end?: number,
             step?: number
         ): number[];
+
+        /**
+         * Creates an array of numbers (positive and/or negative) progressing from start up to, but not including, end.
+         * If end is not specified it’s set to start with start then set to 0. If end is less than start a zero-length
+         * range is created unless a negative step is specified.
+         *
+         * @param start The start of the range.
+         * @param index Not used in this overload.
+         * @param guard Enables use as an iteratee for methods like _.map. You should not pass this parameter directly in your code.
+         * @return Returns a new range array.
+         */
+        range(
+            end: number,
+            index: string | number,
+            guard: object
+        ): number[];
     }
 
     interface LoDashImplicitWrapper<TValue> {
@@ -16775,9 +16898,9 @@ declare namespace _ {
          * descending order.
          *
          * @category Util
-         * @param [start=0] The start of the range.
+         * @param start The start of the range.
          * @param end The end of the range.
-         * @param [step=1] The value to increment or decrement by.
+         * @param step The value to increment or decrement by.
          * @returns Returns the new array of numbers.
          * @example
          *
@@ -16807,6 +16930,21 @@ declare namespace _ {
             end?: number,
             step?: number
         ): number[];
+
+        /**
+         * This method is like _.range except that it populates values in
+         * descending order.
+         *
+         * @param start The start of the range.
+         * @param index Not used in this overload.
+         * @param guard Enables use as an iteratee for methods like _.map. You should not pass this parameter directly in your code.
+         * @return Returns a new range array.
+         */
+        rangeRight(
+            end: number,
+            index: string | number,
+            guard: object
+        ): number[];
     }
 
     interface LoDashImplicitWrapper<TValue> {
@@ -17084,13 +17222,13 @@ declare namespace _ {
     type ArrayIterator<T, TResult> = (value: T, index: number, collection: T[]) => TResult;
     type ListIterator<T, TResult> = (value: T, index: number, collection: List<T>) => TResult;
     type ListIteratee<T> = ListIterator<T, NotVoid> | string | [string, any] | PartialDeep<T>;
-    type ListIterateeCustom<T, TResult> = ListIterator<T, TResult> | string | [string, any] | PartialDeep<T>;
+    type ListIterateeCustom<T, TResult> = ListIterator<T, TResult> | string | object | [string, any] | PartialDeep<T>;
     type ListIteratorTypeGuard<T, S extends T> = (value: T, index: number, collection: List<T>) => value is S;
 
     // Note: key should be string, not keyof T, because the actual object may contain extra properties that were not specified in the type.
     type ObjectIterator<TObject, TResult> = (value: TObject[keyof TObject], key: string, collection: TObject) => TResult;
     type ObjectIteratee<TObject> = ObjectIterator<TObject, NotVoid> | string | [string, any] | PartialDeep<TObject[keyof TObject]>;
-    type ObjectIterateeCustom<TObject, TResult> = ObjectIterator<TObject, TResult> | string | [string, any] | PartialDeep<TObject[keyof TObject]>;
+    type ObjectIterateeCustom<TObject, TResult> = ObjectIterator<TObject, TResult> | string | object | [string, any] | PartialDeep<TObject[keyof TObject]>;
     type ObjectIteratorTypeGuard<TObject, S extends TObject[keyof TObject]> = (value: TObject[keyof TObject], key: string, collection: TObject) => value is S;
 
     type DictionaryIterator<T, TResult> = ObjectIterator<Dictionary<T>, TResult>;