💥 refactor!: Use camelCase naming and document all exports.

BREAKING CHANGE: This breaks dependents relying on the renamed exports.

Author: make-github-pseudonymous-again

src/fromKeys.js

@@ -0,0 +1,11 @@
+/**
+ * Creates a mapping from a sequences of keys and a single value. All keys are
+ * mapped to that single value.
+ *
+ * @param {Iterable} keys
+ * @param {any} value
+ * @return {IterableIterator} The output mapping.
+ */
+export default function* fromKeys(keys, value) {
+	for (const key of keys) yield [key, value];
+}

src/fromkeys.js

@@ -1,3 +1,3 @@
-export {default as fromkeys} from './fromkeys.js';
-export {default as object} from './object.js';
+export {default as fromKeys} from './fromKeys.js';
 export {default as reflect} from './reflect.js';
+export {default as toObject} from './toObject.js';

src/index.js

@@ -1,3 +1,9 @@
+/**
+ * Swap keys and values of a mapping.
+ *
+ * @param {Iterable} mapping The input mapping.
+ * @return {IterableIterator} A new mapping with input keys and values swapped.
+ */
 export default function* reflect(mapping) {
 	for (const [key, value] of mapping) yield [value, key];
 }

src/object.js

@@ -0,0 +1,10 @@
+/**
+ * Instantiate an object from a mapping.
+ *
+ * @deprecated Use Object.fromEntries(mapping) directly.
+ *
+ * @param {Iterable} mapping The input mapping.
+ * @return {Object} The output object.
+ */
+const toObject = (mapping) => Object.fromEntries(mapping);
+export default toObject;

src/reflect.js

@@ -0,0 +1,18 @@
+import test from 'ava';
+
+import {fromKeys} from '../../src/index.js';
+
+test('fromKeys', (t) => {
+	t.deepEqual([...fromKeys('', 1)], []);
+
+	t.deepEqual(
+		[...fromKeys('abcde', 1)],
+		[
+			['a', 1],
+			['b', 1],
+			['c', 1],
+			['d', 1],
+			['e', 1],
+		],
+	);
+});

src/toObject.js

@@ -1,12 +1,12 @@
 import test from 'ava';
 
-import {object} from '../../src/index.js';
+import {toObject} from '../../src/index.js';
 
-test('object', (t) => {
-	t.deepEqual(object([]), {});
+test('toObject', (t) => {
+	t.deepEqual(toObject([]), {});
 
 	t.deepEqual(
-		object([
+		toObject([
 			['a', 0],
 			['b', 1],
 			['c', 2],