@sapphire/iterator-utilities 1.0.1 → 1.0.2-next.0e5c61c4.0

package/README.md

@@ -18,16 +18,63 @@
 -   [Features](#features)
 -   [Installation](#installation)
 -   [Usage](#usage)
-    -   [Resolving](#resolving)
-    -   [Checking for the existence of any bit](#checking-for-the-existence-of-any-bit)
-    -   [Checking for the existence of one or multiple bits](#checking-for-the-existence-of-one-or-multiple-bits)
-    -   [Getting the field's complement](#getting-the-fields-complement)
-    -   [Getting the union of different fields](#getting-the-union-of-different-fields)
-    -   [Getting the intersection between different fields](#getting-the-intersection-between-different-fields)
-    -   [Getting the symmetric difference between different fields](#getting-the-symmetric-difference-between-different-fields)
-    -   [Formatting a field](#formatting-a-field)
+    -   [`append`](#append)
+    -   [`at`](#at)
+    -   [`average`](#average)
+    -   [`chain`](#chain)
+    -   [`chunk`](#chunk)
+    -   [`compact`](#compact)
+    -   [`compress`](#compress)
+    -   [`contains`](#contains)
+    -   [`count`](#count)
+    -   [`cycle`](#cycle)
+    -   [`difference`](#difference)
+    -   [`drop`](#drop)
+    -   [`dropLast`](#droplast)
+    -   [`dropWhile`](#dropwhile)
+    -   [`empty`](#empty)
+    -   [`enumerate`](#enumerate)
+    -   [`every`](#every)
+    -   [`filter`](#filter)
+    -   [`find`](#find)
+    -   [`findIndex`](#findindex)
+    -   [`first`](#first)
+    -   [`flat`](#flat)
+    -   [`flatMap`](#flatmap)
+    -   [`forEach`](#foreach)
+    -   [`from`](#from)
+    -   [`indexOf`](#indexof)
+    -   [`intersect`](#intersect)
+    -   [`isEmpty`](#isempty)
+    -   [`last`](#last)
+    -   [`map`](#map)
+    -   [`max`](#max)
+    -   [`min`](#min)
+    -   [`partition`](#partition)
+    -   [`peekable`](#peekable)
+    -   [`prepend`](#prepend)
+    -   [`product`](#product)
+    -   [`range`](#range)
+    -   [`reduce`](#reduce)
+    -   [`repeat`](#repeat)
+    -   [`reverse`](#reverse)
+    -   [`slice`](#slice)
+    -   [`some`](#some)
+    -   [`sorted`](#sorted)
+    -   [`starMap`](#starmap)
+    -   [`sum`](#sum)
+    -   [`take`](#take)
+    -   [`takeLast`](#takelast)
+    -   [`takeWhile`](#takewhile)
+    -   [`tee`](#tee)
+    -   [`toArray`](#toarray)
+    -   [`toIterableIterator`](#toiterableiterator)
+    -   [`union`](#union)
+    -   [`unique`](#unique)
+    -   [`unzip`](#unzip)
+    -   [`zip`](#zip)
 -   [Buy us some doughnuts](#buy-us-some-doughnuts)
--   [Contributors ✨](#contributors-)
+-   [Contributors](#contributors)
 
 ## Features
 
@@ -284,7 +331,11 @@ console.log(first(iterable));
 Creates an iterable that yields the elements of each iterable in the input iterable.
 
 ```typescript
-const iterable = flat([[1, 2], [3, 4], [5, 6]]);
+const iterable = flat([
+	[1, 2],
+	[3, 4],
+	[5, 6]
+]);
 console.log([...iterable]);
 // Output: [1, 2, 3, 4, 5, 6]
 ```
@@ -577,7 +628,11 @@ console.log([...sorted(iterable)]);
 Creates an iterable with the results of calling a provided function on each element of the input iterables as the function's parameters.
 
 ```typescript
-const iterable = [[1, 2], [3, 4], [5, 6]];
+const iterable = [
+	[1, 2],
+	[3, 4],
+	[5, 6]
+];
 console.log([...starMap(iterable, (a, b) => a + b)]);
 // Output: [3, 7, 11]
 ```
@@ -648,7 +703,11 @@ console.log(toArray(set));
 ```
 
 ```typescript
-const map = new Map([['a', 1], ['b', 2], ['c', 3]]);
+const map = new Map([
+	['a', 1],
+	['b', 2],
+	['c', 3]
+]);
 console.log(toArray(map));
 // Output: [['a', 1], ['b', 2], ['c', 3]]
 ```
@@ -676,7 +735,11 @@ console.log([...toIterableIterator(set)]);
 ```
 
 ```typescript
-const map = new Map([['a', 1], ['b', 2], ['c', 3]]);
+const map = new Map([
+	['a', 1],
+	['b', 2],
+	['c', 3]
+]);
 console.log([...toIterableIterator(map)]);
 // Output: [['a', 1], ['b', 2], ['c', 3]]
 ```
@@ -713,7 +776,11 @@ console.log([...unique(iterable)]);
 Creates an array for each element of the input iterable, transposing the input iterable. The opposite of [`zip`](#zip).
 
 ```typescript
-const iterable = [[1, 'a'], [2, 'b'], [3, 'c']];
+const iterable = [
+	[1, 'a'],
+	[2, 'b'],
+	[3, 'c']
+];
 const [numbers, letters] = unzip(iterable);
 
 console.log(numbers);