Merge pull request microsoft#24527 from sambostock/rename-flatten-to-flat

mhegazy · web-flow · commit fef9fe3b5820 · 2018-05-31T12:13:40.000-07:00
Rename ESNext `flatten` to `flat`
diff --git a/src/lib/esnext.array.d.ts b/src/lib/esnext.array.d.ts
@@ -3,7 +3,7 @@ interface ReadonlyArray<T> {
     /**
      * Calls a defined callback function on each element of an array. Then, flattens the result into
      * a new array.
-     * This is identical to a map followed by a flatten of depth 1.
+     * This is identical to a map followed by flat with depth 1.
      *
      * @param callback A function that accepts up to three arguments. The flatMap method calls the
      * callback function one time for each element in the array.
@@ -22,7 +22,7 @@ interface ReadonlyArray<T> {
      *
      * @param depth The maximum recursion depth
      */
-    flatten<U>(this:
+    flat<U>(this:
         ReadonlyArray<U[][][][]> |
 
         ReadonlyArray<ReadonlyArray<U[][][]>> |
@@ -51,7 +51,7 @@ interface ReadonlyArray<T> {
      *
      * @param depth The maximum recursion depth
      */
-    flatten<U>(this:
+    flat<U>(this:
         ReadonlyArray<U[][][]> |
 
         ReadonlyArray<ReadonlyArray<U>[][]> |
@@ -71,7 +71,7 @@ interface ReadonlyArray<T> {
      *
      * @param depth The maximum recursion depth
      */
-    flatten<U>(this:
+    flat<U>(this:
         ReadonlyArray<U[][]> |
 
         ReadonlyArray<ReadonlyArray<U[]>> |
@@ -86,7 +86,7 @@ interface ReadonlyArray<T> {
      *
      * @param depth The maximum recursion depth
      */
-    flatten<U>(this:
+    flat<U>(this:
         ReadonlyArray<U[]> |
         ReadonlyArray<ReadonlyArray<U>>,
         depth?: 1
@@ -98,26 +98,26 @@ interface ReadonlyArray<T> {
      *
      * @param depth The maximum recursion depth
      */
-    flatten<U>(this:
+    flat<U>(this:
         ReadonlyArray<U>,
         depth: 0
     ): U[];
 
     /**
      * Returns a new array with all sub-array elements concatenated into it recursively up to the
-     * specified depth. If no depth is provided, flatten method defaults to the depth of 1.
+     * specified depth. If no depth is provided, flat method defaults to the depth of 1.
      *
      * @param depth The maximum recursion depth
      */
-    flatten<U>(depth?: number): any[];
+    flat<U>(depth?: number): any[];
   }
 
 interface Array<T> {
 
     /**
      * Calls a defined callback function on each element of an array. Then, flattens the result into
      * a new array.
-     * This is identical to a map followed by a flatten of depth 1.
+     * This is identical to a map followed by flat with depth 1.
      *
      * @param callback A function that accepts up to three arguments. The flatMap method calls the
      * callback function one time for each element in the array.
@@ -135,69 +135,69 @@ interface Array<T> {
      *
      * @param depth The maximum recursion depth
      */
-    flatten<U>(this: U[][][][][][][][], depth: 7): U[];
+    flat<U>(this: U[][][][][][][][], depth: 7): U[];
 
     /**
      * Returns a new array with all sub-array elements concatenated into it recursively up to the
      * specified depth.
      *
      * @param depth The maximum recursion depth
      */
-    flatten<U>(this: U[][][][][][][], depth: 6): U[];
+    flat<U>(this: U[][][][][][][], depth: 6): U[];
 
     /**
      * Returns a new array with all sub-array elements concatenated into it recursively up to the
      * specified depth.
      *
      * @param depth The maximum recursion depth
      */
-    flatten<U>(this: U[][][][][][], depth: 5): U[];
+    flat<U>(this: U[][][][][][], depth: 5): U[];
 
     /**
      * Returns a new array with all sub-array elements concatenated into it recursively up to the
      * specified depth.
      *
      * @param depth The maximum recursion depth
      */
-    flatten<U>(this: U[][][][][], depth: 4): U[];
+    flat<U>(this: U[][][][][], depth: 4): U[];
 
     /**
      * Returns a new array with all sub-array elements concatenated into it recursively up to the
      * specified depth.
      *
      * @param depth The maximum recursion depth
      */
-    flatten<U>(this: U[][][][], depth: 3): U[];
+    flat<U>(this: U[][][][], depth: 3): U[];
 
     /**
      * Returns a new array with all sub-array elements concatenated into it recursively up to the
      * specified depth.
      *
      * @param depth The maximum recursion depth
      */
-    flatten<U>(this: U[][][], depth: 2): U[];
+    flat<U>(this: U[][][], depth: 2): U[];
 
     /**
      * Returns a new array with all sub-array elements concatenated into it recursively up to the
      * specified depth.
      *
      * @param depth The maximum recursion depth
      */
-    flatten<U>(this: U[][], depth?: 1): U[];
+    flat<U>(this: U[][], depth?: 1): U[];
 
     /**
      * Returns a new array with all sub-array elements concatenated into it recursively up to the
      * specified depth.
      *
      * @param depth The maximum recursion depth
      */
-    flatten<U>(this: U[], depth: 0): U[];
+    flat<U>(this: U[], depth: 0): U[];
 
     /**
      * Returns a new array with all sub-array elements concatenated into it recursively up to the
-     * specified depth. If no depth is provided, flatten method defaults to the depth of 1.
+     * specified depth. If no depth is provided, flat method defaults to the depth of 1.
      *
      * @param depth The maximum recursion depth
      */
-    flatten<U>(depth?: number): any[];
+    flat<U>(depth?: number): any[];
 }
