summaryrefslogtreecommitdiff
path: root/school/node_modules/graphql/jsutils/keyMap.js.flow
diff options
context:
space:
mode:
Diffstat (limited to 'school/node_modules/graphql/jsutils/keyMap.js.flow')
-rw-r--r--school/node_modules/graphql/jsutils/keyMap.js.flow35
1 files changed, 35 insertions, 0 deletions
diff --git a/school/node_modules/graphql/jsutils/keyMap.js.flow b/school/node_modules/graphql/jsutils/keyMap.js.flow
new file mode 100644
index 0000000..b165360
--- /dev/null
+++ b/school/node_modules/graphql/jsutils/keyMap.js.flow
@@ -0,0 +1,35 @@
+// @flow strict
+import type { ObjMap } from './ObjMap';
+
+/**
+ * Creates a keyed JS object from an array, given a function to produce the keys
+ * for each value in the array.
+ *
+ * This provides a convenient lookup for the array items if the key function
+ * produces unique results.
+ *
+ * const phoneBook = [
+ * { name: 'Jon', num: '555-1234' },
+ * { name: 'Jenny', num: '867-5309' }
+ * ]
+ *
+ * // { Jon: { name: 'Jon', num: '555-1234' },
+ * // Jenny: { name: 'Jenny', num: '867-5309' } }
+ * const entriesByName = keyMap(
+ * phoneBook,
+ * entry => entry.name
+ * )
+ *
+ * // { name: 'Jenny', num: '857-6309' }
+ * const jennyEntry = entriesByName['Jenny']
+ *
+ */
+export default function keyMap<T>(
+ list: $ReadOnlyArray<T>,
+ keyFn: (item: T) => string,
+): ObjMap<T> {
+ return list.reduce((map, item) => {
+ map[keyFn(item)] = item;
+ return map;
+ }, Object.create(null));
+}