Merge c25a5f2 into ebefa4c

publicstrategies · May 23, 2020 · d30ebed · d30ebed
2 parents ebefa4c + c25a5f2
commit d30ebed
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -28,10 +28,14 @@ between them.</p>
 
 **Example**  
 ```ts
-const data = [{ name: "John", id: 1 }, { name: "Jane", id: 2 }];
+const data = [
+  { complex: { value: 'x' }, id: 1, name: 'John' },
+  { complex: { value: 'y' }, id: 2, name: 'Jane' },
+];
 
-arrayOf(data, "name"); // ["John", "Jane"]
+arrayOf(data, "complex"); // [{ value: 'x' }, { value: 'y' }]
 arrayOf(data, "id"); // [1, 2]
+arrayOf(data, "name"); // ["John", "Jane"]
 ```
 <a name="sumOf"></a>
 

diff --git a/src/arrayOf.ts b/src/arrayOf.ts
@@ -11,10 +11,14 @@ const byKey = <T extends unknown, K extends keyof T>(key: K) => (
  * @returns {any[]}
  * @example
  * ```ts
- * const data = [{ name: "John", id: 1 }, { name: "Jane", id: 2 }];
+ * const data = [
+ *   { complex: { value: 'x' }, id: 1, name: 'John' },
+ *   { complex: { value: 'y' }, id: 2, name: 'Jane' },
+ * ];
  *
- * arrayOf(data, "name"); // ["John", "Jane"]
+ * arrayOf(data, "complex"); // [{ value: 'x' }, { value: 'y' }]
  * arrayOf(data, "id"); // [1, 2]
+ * arrayOf(data, "name"); // ["John", "Jane"]
  * ```
  */
 export const arrayOf = <T extends unknown, K extends keyof T>(