✨ feat: More conversion functions.

Undeprecate toObject. Add fromObject, toMap, and fromMap. Fixes #102.

Author: make-github-pseudonymous-again

README.md

@@ -14,10 +14,11 @@ import {enumerate} from '@iterable-iterator/zip';
 reflect(enumerate('ab')); // ['a', 0] ['b', 1]
 
 // You can convert to and from Object and Map
-Object.fromEntries(mapping) -> Object
-Object.entries(object) -> mapping
-new Map(mapping) -> Map
-map.entries() -> mapping
+import {toObject, fromObject, toMap, fromMap} from '@iterable-iterator/mapping' ;
+toObject(mapping) -> Object
+fromObject(Object) -> mapping
+toMap(mapping) -> Map
+fromMap(Map) -> mapping
 ```
 
 [![License](https://img.shields.io/github/license/iterable-iterator/mapping.svg)](https://raw.githubusercontent.com/iterable-iterator/mapping/main/LICENSE)

src/fromMap.js

@@ -0,0 +1,8 @@
+/**
+ * Instantiate a mapping from a map.
+ *
+ * @param {Map} map The input map.
+ * @return {IterableIterator} The output mapping.
+ */
+const fromMap = (map) => map.entries();
+export default fromMap;

src/fromObject.js

@@ -0,0 +1,8 @@
+/**
+ * Instantiate a mapping from an object.
+ *
+ * @param {Object} object The input object.
+ * @return {IterableIterator} The output mapping.
+ */
+const fromObject = (object) => Object.entries(object)[Symbol.iterator]();
+export default fromObject;

src/index.js

@@ -1,3 +1,6 @@
 export {default as constant} from './constant.js';
+export {default as fromMap} from './fromMap.js';
+export {default as fromObject} from './fromObject.js';
 export {default as reflect} from './reflect.js';
+export {default as toMap} from './toMap.js';
 export {default as toObject} from './toObject.js';

src/toMap.js

@@ -0,0 +1,8 @@
+/**
+ * Instantiate a map from a mapping.
+ *
+ * @param {Iterable} mapping The input mapping.
+ * @return {Map} The output map.
+ */
+const toMap = (mapping) => new Map(mapping);
+export default toMap;

src/toObject.js

@@ -1,8 +1,6 @@
 /**
  * Instantiate an object from a mapping.
  *
- * @deprecated Use Object.fromEntries(mapping) directly.
- *
  * @param {Iterable} mapping The input mapping.
  * @return {Object} The output object.
  */

test/src/_fixtures.js

@@ -0,0 +1 @@
+export const repr = (x) => JSON.stringify(x);

test/src/fromMap.js

@@ -0,0 +1,16 @@
+import test from 'ava';
+
+import {enumerate} from '@iterable-iterator/zip';
+import {fromMap} from '../../src/index.js';
+
+import {repr} from './_fixtures.js';
+
+const macro = (t, mapping) => {
+	t.deepEqual(Array.from(fromMap(new Map(mapping))), Array.from(mapping));
+};
+
+macro.title = (title, mapping) =>
+	title ?? `fromMap(new Map(${repr(mapping)})) is ${repr(mapping)}`;
+
+test(macro, []);
+test(macro, Array.from(enumerate('abcde')));

test/src/fromObject.js

@@ -0,0 +1,15 @@
+import test from 'ava';
+
+import {fromObject} from '../../src/index.js';
+
+test('fromObject', (t) => {
+	t.deepEqual(Array.from(fromObject({})), []);
+
+	t.deepEqual(Array.from(fromObject({a: 0, b: 1, c: 2, d: 3, e: 4})), [
+		['a', 0],
+		['b', 1],
+		['c', 2],
+		['d', 3],
+		['e', 4],
+	]);
+});

test/src/toMap.js

@@ -0,0 +1,16 @@
+import test from 'ava';
+
+import {enumerate} from '@iterable-iterator/zip';
+import {toMap} from '../../src/index.js';
+
+import {repr} from './_fixtures.js';
+
+const macro = (t, mapping) => {
+	t.deepEqual(toMap(mapping), new Map(mapping));
+};
+
+macro.title = (title, mapping) =>
+	title ?? `toMap(${repr(mapping)}) is new Map(${repr(mapping)})`;
+
+test(macro, []);
+test(macro, Array.from(enumerate('abcde')));