@ts-fns/stdlib 0.1.0 → 0.2.0

package/dist/map/index.cjs

@@ -1,12 +1,36 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const require_purry = require("../purry-B2_0DGLV.cjs");
+const require_purry = require("../purry-Dqp_F64t.cjs");
+const require_errors = require("../errors-O-d_Vemi.cjs");
+//#region src/map/_globalAliases.ts
+/**
+* Alias of the built-in map constructor. `new Map() === new Map.Ctor()`
+* @function
+*/
+const Ctor = Map;
+//#endregion
 //#region src/map/clear.ts
+/**
+* Removes all entries from a map and returns the same map.
+*
+* @example
+* ```ts
+* clear(new Map([['a', 1], ['b', 2]])); // Map(0) {}
+* ```
+*/
 function clear(data) {
 	data.clear();
 	return data;
 }
 //#endregion
 //#region src/map/entries.ts
+/**
+* Returns an iterator of a map's key-value pairs.
+*
+* @example
+* ```ts
+* [...entries(new Map([['a', 1], ['b', 2]]))]; // [['a', 1], ['b', 2]]
+* ```
+*/
 function entries(data) {
 	return data.entries();
 }
@@ -21,9 +45,25 @@ function forEach(...args) {
 }
 //#endregion
 //#region src/map/from.ts
+/**
+* Creates a map from an iterable of key-value pairs.
+*
+* @example
+* ```ts
+* from([['a', 1], ['b', 2]]); // Map { 'a' => 1, 'b' => 2 }
+* ```
+*/
 function from(iterable) {
 	return new Map(iterable);
 }
+/**
+* Creates an empty map.
+*
+* @example
+* ```ts
+* empty(); // Map(0) {}
+* ```
+*/
 function empty() {
 	return /* @__PURE__ */ new Map();
 }
@@ -36,6 +76,34 @@ function get(...args) {
 	return require_purry.purry(getImplementation, args);
 }
 //#endregion
+//#region src/map/getOrInsert.ts
+/**
+* Inserts a default value when a key is absent and returns the same map.
+*
+* @example
+* ```ts
+* const map = new Map<string, number>();
+* getOrInsert(map, 'a', 1); // Map { 'a' => 1 }
+* getOrInsert(map, 'a', 2); // Map { 'a' => 1 }
+* ```
+*/
+function getOrInsert(map, key, defaultValue) {
+	throw new require_errors.NotYetImplementedError("M.getOrInsert not yet implemented");
+}
+/**
+* Inserts a computed value when a key is absent and returns the same map.
+*
+* @example
+* ```ts
+* const map = new Map<string, number>();
+* getOrInsertComputed(map, 'a', () => 1); // Map { 'a' => 1 }
+* getOrInsertComputed(map, 'a', () => 2); // Map { 'a' => 1 }
+* ```
+*/
+function getOrInsertComputed(map, key, callback) {
+	throw new require_errors.NotYetImplementedError("M.getOrInsertComputed not yet implemented");
+}
+//#endregion
 //#region src/map/groupBy.ts
 function groupByImplementation(items, keySelector) {
 	return Map.groupBy(items, keySelector);
@@ -45,6 +113,14 @@ function groupBy(...args) {
 }
 //#endregion
 //#region src/map/keys.ts
+/**
+* Returns an iterator of a map's keys.
+*
+* @example
+* ```ts
+* [...keys(new Map([['a', 1], ['b', 2]]))]; // ['a', 'b']
+* ```
+*/
 function keys(data) {
 	return data.keys();
 }
@@ -67,16 +143,27 @@ function set(...args) {
 }
 //#endregion
 //#region src/map/values.ts
+/**
+* Returns an iterator of a map's values.
+*
+* @example
+* ```ts
+* [...values(new Map([['a', 1], ['b', 2]]))]; // [1, 2]
+* ```
+*/
 function values(data) {
 	return data.values();
 }
 //#endregion
+exports.Ctor = Ctor;
 exports.clear = clear;
 exports.empty = empty;
 exports.entries = entries;
 exports.forEach = forEach;
 exports.from = from;
 exports.get = get;
+exports.getOrInsert = getOrInsert;
+exports.getOrInsertComputed = getOrInsertComputed;
 exports.groupBy = groupBy;
 exports.keys = keys;
 exports.remove = remove;

package/dist/map/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","names":["purry","purry","purry","purry","purry"],"sources":["../../src/map/clear.ts","../../src/map/entries.ts","../../src/map/forEach.ts","../../src/map/from.ts","../../src/map/get.ts","../../src/map/groupBy.ts","../../src/map/keys.ts","../../src/map/remove.ts","../../src/map/set.ts","../../src/map/values.ts"],"sourcesContent":["export function clear<K, V>(data: Map<K, V>): Map<K, V> {\n  data.clear();\n  return data;\n}\n","export function entries<K, V>(data: Map<K, V>): MapIterator<[K, V]> {\n  return data.entries();\n}\n","import { purry } from '../function/purry';\n\nfunction forEachImplementation<K, V>(\n  data: Map<K, V>,\n  callbackfn: (value: V, key: K, map: Map<K, V>) => void,\n): Map<K, V> {\n  data.forEach(callbackfn);\n  return data;\n}\n\nexport function forEach<K, V>(callbackfn: (value: V, key: K, set: Map<K, V>) => void): (data: Map<K, V>) => Map<K, V>;\nexport function forEach<K, V>(data: Map<K, V>, callbackfn: (value: V, key: K, set: Map<K, V>) => void): Map<K, V>;\nexport function forEach(...args: readonly unknown[]): unknown {\n  return purry(forEachImplementation, args);\n}\n","export function from<K, V>(iterable: Iterable<[K, V]> | readonly (readonly [K, V])[]): Map<K, V> {\n  return new Map(iterable);\n}\n\nexport function empty<K, V>(): Map<K, V> {\n  return new Map();\n}\n","import { purry } from '../function/purry';\n\nfunction getImplementation<K, V>(data: Map<K, V>, key: K): V | undefined {\n  return data.get(key);\n}\n\nexport function get<K>(key: K): <V>(data: Map<K, V>) => V | undefined;\nexport function get<K, V>(data: Map<K, V>, key: K): V | undefined;\nexport function get(...args: readonly unknown[]): unknown {\n  return purry(getImplementation, args);\n}\n","import { purry } from '../function/purry';\n\nfunction groupByImplementation<K, T>(items: Iterable<T>, keySelector: (item: T, index: number) => K): Map<K, T[]> {\n  return Map.groupBy(items, keySelector);\n}\n\nexport function groupBy<K, T>(keySelector: (item: T, index: number) => K): (items: Iterable<T>) => Map<K, T[]>;\nexport function groupBy<K, T>(items: Iterable<T>, keySelector: (item: T, index: number) => K): Map<K, T[]>;\nexport function groupBy(...args: readonly unknown[]): unknown {\n  return purry(groupByImplementation, args);\n}\n","export function keys<K, V>(data: Map<K, V>): MapIterator<K> {\n  return data.keys();\n}\n","import { purry } from '../function/purry';\n\nfunction removeImplementation<K, V>(data: Map<K, V>, key: K): Map<K, V> {\n  data.delete(key);\n  return data;\n}\n\n/**\n * TODO: should this return a tuple?\n */\nexport function remove<K>(key: K): <V>(data: Map<K, V>) => Map<K, V>;\nexport function remove<K, V>(data: Map<K, V>, key: K): Map<K, V>;\nexport function remove(...args: readonly unknown[]): unknown {\n  return purry(removeImplementation, args);\n}\n","import { purry } from '../function/purry';\n\nfunction setImplementation<K, V>(data: Map<K, V>, key: K, value: V): Map<K, V> {\n  return data.set(key, value);\n}\n\nexport function set<K, V>(key: K, value: V): (data: Map<K, V>) => Map<K, V>;\nexport function set<K, V>(data: Map<K, V>, key: K, value: V): Map<K, V>;\nexport function set(...args: readonly unknown[]): unknown {\n  return purry(setImplementation, args);\n}\n","export function values<K, V>(data: Map<K, V>): MapIterator<V> {\n  return data.values();\n}\n"],"mappings":";;;AAAA,SAAgB,MAAY,MAA4B;CACtD,KAAK,MAAM;CACX,OAAO;AACT;;;ACHA,SAAgB,QAAc,MAAsC;CAClE,OAAO,KAAK,QAAQ;AACtB;;;ACAA,SAAS,sBACP,MACA,YACW;CACX,KAAK,QAAQ,UAAU;CACvB,OAAO;AACT;AAIA,SAAgB,QAAQ,GAAG,MAAmC;CAC5D,OAAOA,cAAAA,MAAM,uBAAuB,IAAI;AAC1C;;;ACdA,SAAgB,KAAW,UAAsE;CAC/F,OAAO,IAAI,IAAI,QAAQ;AACzB;AAEA,SAAgB,QAAyB;CACvC,uBAAO,IAAI,IAAI;AACjB;;;ACJA,SAAS,kBAAwB,MAAiB,KAAuB;CACvE,OAAO,KAAK,IAAI,GAAG;AACrB;AAIA,SAAgB,IAAI,GAAG,MAAmC;CACxD,OAAOC,cAAAA,MAAM,mBAAmB,IAAI;AACtC;;;ACRA,SAAS,sBAA4B,OAAoB,aAAyD;CAChH,OAAO,IAAI,QAAQ,OAAO,WAAW;AACvC;AAIA,SAAgB,QAAQ,GAAG,MAAmC;CAC5D,OAAOC,cAAAA,MAAM,uBAAuB,IAAI;AAC1C;;;ACVA,SAAgB,KAAW,MAAiC;CAC1D,OAAO,KAAK,KAAK;AACnB;;;ACAA,SAAS,qBAA2B,MAAiB,KAAmB;CACtE,KAAK,OAAO,GAAG;CACf,OAAO;AACT;AAOA,SAAgB,OAAO,GAAG,MAAmC;CAC3D,OAAOC,cAAAA,MAAM,sBAAsB,IAAI;AACzC;;;ACZA,SAAS,kBAAwB,MAAiB,KAAQ,OAAqB;CAC7E,OAAO,KAAK,IAAI,KAAK,KAAK;AAC5B;AAIA,SAAgB,IAAI,GAAG,MAAmC;CACxD,OAAOC,cAAAA,MAAM,mBAAmB,IAAI;AACtC;;;ACVA,SAAgB,OAAa,MAAiC;CAC5D,OAAO,KAAK,OAAO;AACrB"}
+{"version":3,"file":"index.cjs","names":["purry","purry","NotYetImplementedError","purry","purry","purry"],"sources":["../../src/map/_globalAliases.ts","../../src/map/clear.ts","../../src/map/entries.ts","../../src/map/forEach.ts","../../src/map/from.ts","../../src/map/get.ts","../../src/map/getOrInsert.ts","../../src/map/groupBy.ts","../../src/map/keys.ts","../../src/map/remove.ts","../../src/map/set.ts","../../src/map/values.ts"],"sourcesContent":["/**\n * Alias of the built-in map constructor. `new Map() === new Map.Ctor()`\n * @function\n */\nexport const Ctor = Map;\n","/**\n * Removes all entries from a map and returns the same map.\n *\n * @example\n * ```ts\n * clear(new Map([['a', 1], ['b', 2]])); // Map(0) {}\n * ```\n */\nexport function clear<K, V>(data: Map<K, V>): Map<K, V> {\n  data.clear();\n  return data;\n}\n","/**\n * Returns an iterator of a map's key-value pairs.\n *\n * @example\n * ```ts\n * [...entries(new Map([['a', 1], ['b', 2]]))]; // [['a', 1], ['b', 2]]\n * ```\n */\nexport function entries<K, V>(data: Map<K, V>): MapIterator<[K, V]> {\n  return data.entries();\n}\n","import { purry } from '../function/purry';\n\nfunction forEachImplementation<K, V>(\n  data: Map<K, V>,\n  callbackfn: (value: V, key: K, map: Map<K, V>) => void,\n): Map<K, V> {\n  data.forEach(callbackfn);\n  return data;\n}\n\n/**\n * Runs a callback for each map entry and returns the same map.\n *\n * @example\n * ```ts\n * const map = new Map([['a', 1], ['b', 2]]);\n * forEach(map, (value, key) => console.log(key, value)); // map\n * forEach((value, key) => console.log(key, value))(map); // map\n * ```\n */\nexport function forEach<K, V>(callbackfn: (value: V, key: K, set: Map<K, V>) => void): (data: Map<K, V>) => Map<K, V>;\nexport function forEach<K, V>(data: Map<K, V>, callbackfn: (value: V, key: K, set: Map<K, V>) => void): Map<K, V>;\nexport function forEach(...args: readonly unknown[]): unknown {\n  return purry(forEachImplementation, args);\n}\n","/**\n * Creates a map from an iterable of key-value pairs.\n *\n * @example\n * ```ts\n * from([['a', 1], ['b', 2]]); // Map { 'a' => 1, 'b' => 2 }\n * ```\n */\nexport function from<K, V>(iterable: Iterable<[K, V]> | readonly (readonly [K, V])[]): Map<K, V> {\n  return new Map(iterable);\n}\n\n/**\n * Creates an empty map.\n *\n * @example\n * ```ts\n * empty(); // Map(0) {}\n * ```\n */\nexport function empty<K, V>(): Map<K, V> {\n  return new Map();\n}\n","import { purry } from '../function/purry';\n\nfunction getImplementation<K, V>(data: Map<K, V>, key: K): V | undefined {\n  return data.get(key);\n}\n\n/**\n * Returns the value associated with a key, or `undefined` when the key is absent.\n *\n * @example\n * ```ts\n * const map = new Map([['a', 1]]);\n * get(map, 'a'); // 1\n * get(map, 'b'); // undefined\n * get('a')(map); // 1\n * ```\n */\nexport function get<K>(key: K): <V>(data: Map<K, V>) => V | undefined;\nexport function get<K, V>(data: Map<K, V>, key: K): V | undefined;\nexport function get(...args: readonly unknown[]): unknown {\n  return purry(getImplementation, args);\n}\n","import { NotYetImplementedError } from '../errors';\n\n/**\n * Inserts a default value when a key is absent and returns the same map.\n *\n * @example\n * ```ts\n * const map = new Map<string, number>();\n * getOrInsert(map, 'a', 1); // Map { 'a' => 1 }\n * getOrInsert(map, 'a', 2); // Map { 'a' => 1 }\n * ```\n */\n// eslint-disable-next-line @typescript-eslint/no-unused-vars\nexport function getOrInsert<K, V>(map: Map<K, V>, key: K, defaultValue: V): Map<K, V> {\n  throw new NotYetImplementedError('M.getOrInsert not yet implemented');\n}\n\n/**\n * Inserts a computed value when a key is absent and returns the same map.\n *\n * @example\n * ```ts\n * const map = new Map<string, number>();\n * getOrInsertComputed(map, 'a', () => 1); // Map { 'a' => 1 }\n * getOrInsertComputed(map, 'a', () => 2); // Map { 'a' => 1 }\n * ```\n */\n// eslint-disable-next-line @typescript-eslint/no-unused-vars\nexport function getOrInsertComputed<K, V>(map: Map<K, V>, key: K, callback: (key: K) => V): Map<K, V> {\n  throw new NotYetImplementedError('M.getOrInsertComputed not yet implemented');\n}\n","import { purry } from '../function/purry';\n\nfunction groupByImplementation<K, T>(items: Iterable<T>, keySelector: (item: T, index: number) => K): Map<K, T[]> {\n  return Map.groupBy(items, keySelector);\n}\n\n/**\n * Groups iterable items into a map keyed by a selector function.\n *\n * @example\n * ```ts\n * groupBy(\n *   [{ id: 1 }, { id: 2 }, { id: 1 }],\n *   item => item.id,\n * ); // Map { 1 => [{ id: 1 }, { id: 1 }], 2 => [{ id: 2 }] }\n * groupBy(item => item.id)([{ id: 1 }, { id: 2 }]); // Map { 1 => [...], 2 => [...] }\n * ```\n */\nexport function groupBy<K, T>(keySelector: (item: T, index: number) => K): (items: Iterable<T>) => Map<K, T[]>;\nexport function groupBy<K, T>(items: Iterable<T>, keySelector: (item: T, index: number) => K): Map<K, T[]>;\nexport function groupBy(...args: readonly unknown[]): unknown {\n  return purry(groupByImplementation, args);\n}\n","/**\n * Returns an iterator of a map's keys.\n *\n * @example\n * ```ts\n * [...keys(new Map([['a', 1], ['b', 2]]))]; // ['a', 'b']\n * ```\n */\nexport function keys<K, V>(data: Map<K, V>): MapIterator<K> {\n  return data.keys();\n}\n","import { purry } from '../function/purry';\n\nfunction removeImplementation<K, V>(data: Map<K, V>, key: K): Map<K, V> {\n  data.delete(key);\n  return data;\n}\n\n/**\n * Removes an entry by key and returns the same map.\n *\n * @example\n * ```ts\n * const map = new Map([['a', 1], ['b', 2]]);\n * remove(map, 'a'); // Map { 'b' => 2 }\n * remove('b')(map); // Map(0) {}\n * ```\n */\nexport function remove<K>(key: K): <V>(data: Map<K, V>) => Map<K, V>;\nexport function remove<K, V>(data: Map<K, V>, key: K): Map<K, V>;\nexport function remove(...args: readonly unknown[]): unknown {\n  return purry(removeImplementation, args);\n}\n","import { purry } from '../function/purry';\n\nfunction setImplementation<K, V>(data: Map<K, V>, key: K, value: V): Map<K, V> {\n  return data.set(key, value);\n}\n\n/**\n * Sets a key-value pair and returns the same map.\n *\n * @example\n * ```ts\n * set(new Map(), 'a', 1); // Map { 'a' => 1 }\n * set('b', 2)(new Map([['a', 1]])); // Map { 'a' => 1, 'b' => 2 }\n * ```\n */\nexport function set<K, V>(key: K, value: V): (data: Map<K, V>) => Map<K, V>;\nexport function set<K, V>(data: Map<K, V>, key: K, value: V): Map<K, V>;\nexport function set(...args: readonly unknown[]): unknown {\n  return purry(setImplementation, args);\n}\n","/**\n * Returns an iterator of a map's values.\n *\n * @example\n * ```ts\n * [...values(new Map([['a', 1], ['b', 2]]))]; // [1, 2]\n * ```\n */\nexport function values<K, V>(data: Map<K, V>): MapIterator<V> {\n  return data.values();\n}\n"],"mappings":";;;;;;;;AAIA,MAAa,OAAO;;;;;;;;;;;ACIpB,SAAgB,MAAY,MAA4B;CACtD,KAAK,MAAM;CACX,OAAO;AACT;;;;;;;;;;;ACHA,SAAgB,QAAc,MAAsC;CAClE,OAAO,KAAK,QAAQ;AACtB;;;ACRA,SAAS,sBACP,MACA,YACW;CACX,KAAK,QAAQ,UAAU;CACvB,OAAO;AACT;AAcA,SAAgB,QAAQ,GAAG,MAAmC;CAC5D,OAAOA,cAAAA,MAAM,uBAAuB,IAAI;AAC1C;;;;;;;;;;;AChBA,SAAgB,KAAW,UAAsE;CAC/F,OAAO,IAAI,IAAI,QAAQ;AACzB;;;;;;;;;AAUA,SAAgB,QAAyB;CACvC,uBAAO,IAAI,IAAI;AACjB;;;ACpBA,SAAS,kBAAwB,MAAiB,KAAuB;CACvE,OAAO,KAAK,IAAI,GAAG;AACrB;AAeA,SAAgB,IAAI,GAAG,MAAmC;CACxD,OAAOC,cAAAA,MAAM,mBAAmB,IAAI;AACtC;;;;;;;;;;;;;ACRA,SAAgB,YAAkB,KAAgB,KAAQ,cAA4B;CACpF,MAAM,IAAIC,eAAAA,uBAAuB,mCAAmC;AACtE;;;;;;;;;;;AAaA,SAAgB,oBAA0B,KAAgB,KAAQ,UAAoC;CACpG,MAAM,IAAIA,eAAAA,uBAAuB,2CAA2C;AAC9E;;;AC5BA,SAAS,sBAA4B,OAAoB,aAAyD;CAChH,OAAO,IAAI,QAAQ,OAAO,WAAW;AACvC;AAgBA,SAAgB,QAAQ,GAAG,MAAmC;CAC5D,OAAOC,cAAAA,MAAM,uBAAuB,IAAI;AAC1C;;;;;;;;;;;ACdA,SAAgB,KAAW,MAAiC;CAC1D,OAAO,KAAK,KAAK;AACnB;;;ACRA,SAAS,qBAA2B,MAAiB,KAAmB;CACtE,KAAK,OAAO,GAAG;CACf,OAAO;AACT;AAcA,SAAgB,OAAO,GAAG,MAAmC;CAC3D,OAAOC,cAAAA,MAAM,sBAAsB,IAAI;AACzC;;;ACnBA,SAAS,kBAAwB,MAAiB,KAAQ,OAAqB;CAC7E,OAAO,KAAK,IAAI,KAAK,KAAK;AAC5B;AAaA,SAAgB,IAAI,GAAG,MAAmC;CACxD,OAAOC,cAAAA,MAAM,mBAAmB,IAAI;AACtC;;;;;;;;;;;ACXA,SAAgB,OAAa,MAAiC;CAC5D,OAAO,KAAK,OAAO;AACrB"}

package/dist/map/index.d.cts

@@ -1,41 +1,169 @@
+//#region src/map/_globalAliases.d.ts
+/**
+ * Alias of the built-in map constructor. `new Map() === new Map.Ctor()`
+ * @function
+ */
+declare const Ctor: MapConstructor;
+//#endregion
 //#region src/map/clear.d.ts
+/**
+ * Removes all entries from a map and returns the same map.
+ *
+ * @example
+ * ```ts
+ * clear(new Map([['a', 1], ['b', 2]])); // Map(0) {}
+ * ```
+ */
 declare function clear<K, V>(data: Map<K, V>): Map<K, V>;
 //#endregion
 //#region src/map/entries.d.ts
+/**
+ * Returns an iterator of a map's key-value pairs.
+ *
+ * @example
+ * ```ts
+ * [...entries(new Map([['a', 1], ['b', 2]]))]; // [['a', 1], ['b', 2]]
+ * ```
+ */
 declare function entries<K, V>(data: Map<K, V>): MapIterator<[K, V]>;
 //#endregion
 //#region src/map/forEach.d.ts
+/**
+ * Runs a callback for each map entry and returns the same map.
+ *
+ * @example
+ * ```ts
+ * const map = new Map([['a', 1], ['b', 2]]);
+ * forEach(map, (value, key) => console.log(key, value)); // map
+ * forEach((value, key) => console.log(key, value))(map); // map
+ * ```
+ */
 declare function forEach<K, V>(callbackfn: (value: V, key: K, set: Map<K, V>) => void): (data: Map<K, V>) => Map<K, V>;
 declare function forEach<K, V>(data: Map<K, V>, callbackfn: (value: V, key: K, set: Map<K, V>) => void): Map<K, V>;
 //#endregion
 //#region src/map/from.d.ts
+/**
+ * Creates a map from an iterable of key-value pairs.
+ *
+ * @example
+ * ```ts
+ * from([['a', 1], ['b', 2]]); // Map { 'a' => 1, 'b' => 2 }
+ * ```
+ */
 declare function from<K, V>(iterable: Iterable<[K, V]> | readonly (readonly [K, V])[]): Map<K, V>;
+/**
+ * Creates an empty map.
+ *
+ * @example
+ * ```ts
+ * empty(); // Map(0) {}
+ * ```
+ */
 declare function empty<K, V>(): Map<K, V>;
 //#endregion
 //#region src/map/get.d.ts
+/**
+ * Returns the value associated with a key, or `undefined` when the key is absent.
+ *
+ * @example
+ * ```ts
+ * const map = new Map([['a', 1]]);
+ * get(map, 'a'); // 1
+ * get(map, 'b'); // undefined
+ * get('a')(map); // 1
+ * ```
+ */
 declare function get<K>(key: K): <V>(data: Map<K, V>) => V | undefined;
 declare function get<K, V>(data: Map<K, V>, key: K): V | undefined;
 //#endregion
+//#region src/map/getOrInsert.d.ts
+/**
+ * Inserts a default value when a key is absent and returns the same map.
+ *
+ * @example
+ * ```ts
+ * const map = new Map<string, number>();
+ * getOrInsert(map, 'a', 1); // Map { 'a' => 1 }
+ * getOrInsert(map, 'a', 2); // Map { 'a' => 1 }
+ * ```
+ */
+declare function getOrInsert<K, V>(map: Map<K, V>, key: K, defaultValue: V): Map<K, V>;
+/**
+ * Inserts a computed value when a key is absent and returns the same map.
+ *
+ * @example
+ * ```ts
+ * const map = new Map<string, number>();
+ * getOrInsertComputed(map, 'a', () => 1); // Map { 'a' => 1 }
+ * getOrInsertComputed(map, 'a', () => 2); // Map { 'a' => 1 }
+ * ```
+ */
+declare function getOrInsertComputed<K, V>(map: Map<K, V>, key: K, callback: (key: K) => V): Map<K, V>;
+//#endregion
 //#region src/map/groupBy.d.ts
+/**
+ * Groups iterable items into a map keyed by a selector function.
+ *
+ * @example
+ * ```ts
+ * groupBy(
+ *   [{ id: 1 }, { id: 2 }, { id: 1 }],
+ *   item => item.id,
+ * ); // Map { 1 => [{ id: 1 }, { id: 1 }], 2 => [{ id: 2 }] }
+ * groupBy(item => item.id)([{ id: 1 }, { id: 2 }]); // Map { 1 => [...], 2 => [...] }
+ * ```
+ */
 declare function groupBy<K, T>(keySelector: (item: T, index: number) => K): (items: Iterable<T>) => Map<K, T[]>;
 declare function groupBy<K, T>(items: Iterable<T>, keySelector: (item: T, index: number) => K): Map<K, T[]>;
 //#endregion
 //#region src/map/keys.d.ts
+/**
+ * Returns an iterator of a map's keys.
+ *
+ * @example
+ * ```ts
+ * [...keys(new Map([['a', 1], ['b', 2]]))]; // ['a', 'b']
+ * ```
+ */
 declare function keys<K, V>(data: Map<K, V>): MapIterator<K>;
 //#endregion
 //#region src/map/remove.d.ts
 /**
- * TODO: should this return a tuple?
+ * Removes an entry by key and returns the same map.
+ *
+ * @example
+ * ```ts
+ * const map = new Map([['a', 1], ['b', 2]]);
+ * remove(map, 'a'); // Map { 'b' => 2 }
+ * remove('b')(map); // Map(0) {}
+ * ```
  */
 declare function remove<K>(key: K): <V>(data: Map<K, V>) => Map<K, V>;
 declare function remove<K, V>(data: Map<K, V>, key: K): Map<K, V>;
 //#endregion
 //#region src/map/set.d.ts
+/**
+ * Sets a key-value pair and returns the same map.
+ *
+ * @example
+ * ```ts
+ * set(new Map(), 'a', 1); // Map { 'a' => 1 }
+ * set('b', 2)(new Map([['a', 1]])); // Map { 'a' => 1, 'b' => 2 }
+ * ```
+ */
 declare function set<K, V>(key: K, value: V): (data: Map<K, V>) => Map<K, V>;
 declare function set<K, V>(data: Map<K, V>, key: K, value: V): Map<K, V>;
 //#endregion
 //#region src/map/values.d.ts
+/**
+ * Returns an iterator of a map's values.
+ *
+ * @example
+ * ```ts
+ * [...values(new Map([['a', 1], ['b', 2]]))]; // [1, 2]
+ * ```
+ */
 declare function values<K, V>(data: Map<K, V>): MapIterator<V>;
 //#endregion
-export { clear, empty, entries, forEach, from, get, groupBy, keys, remove, set, values };
+export { Ctor, clear, empty, entries, forEach, from, get, getOrInsert, getOrInsertComputed, groupBy, keys, remove, set, values };
 //# sourceMappingURL=index.d.cts.map

package/dist/map/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","names":[],"sources":["../../src/map/clear.ts","../../src/map/entries.ts","../../src/map/forEach.ts","../../src/map/from.ts","../../src/map/get.ts","../../src/map/groupBy.ts","../../src/map/keys.ts","../../src/map/remove.ts","../../src/map/set.ts","../../src/map/values.ts"],"mappings":";iBAAgB,KAAA,OAAY,IAAA,EAAM,GAAA,CAAI,CAAA,EAAG,CAAA,IAAK,GAAA,CAAI,CAAA,EAAG,CAAA;;;iBCArC,OAAA,OAAc,IAAA,EAAM,GAAA,CAAI,CAAA,EAAG,CAAA,IAAK,WAAA,EAAa,CAAA,EAAG,CAAA;;;iBCUhD,OAAA,OAAc,UAAA,GAAa,KAAA,EAAO,CAAA,EAAG,GAAA,EAAK,CAAA,EAAG,GAAA,EAAK,GAAA,CAAI,CAAA,EAAG,CAAA,cAAe,IAAA,EAAM,GAAA,CAAI,CAAA,EAAG,CAAA,MAAO,GAAA,CAAI,CAAA,EAAG,CAAA;AAAA,iBACnG,OAAA,OAAc,IAAA,EAAM,GAAA,CAAI,CAAA,EAAG,CAAA,GAAI,UAAA,GAAa,KAAA,EAAO,CAAA,EAAG,GAAA,EAAK,CAAA,EAAG,GAAA,EAAK,GAAA,CAAI,CAAA,EAAG,CAAA,aAAc,GAAA,CAAI,CAAA,EAAG,CAAA;;;iBCX/F,IAAA,OAAW,QAAA,EAAU,QAAA,EAAU,CAAA,EAAG,CAAA,yBAA0B,CAAA,EAAG,CAAA,OAAQ,GAAA,CAAI,CAAA,EAAG,CAAA;AAAA,iBAI9E,KAAA,UAAe,GAAA,CAAI,CAAA,EAAG,CAAA;;;iBCEtB,GAAA,IAAO,GAAA,EAAK,CAAA,OAAQ,IAAA,EAAM,GAAA,CAAI,CAAA,EAAG,CAAA,MAAO,CAAA;AAAA,iBACxC,GAAA,OAAU,IAAA,EAAM,GAAA,CAAI,CAAA,EAAG,CAAA,GAAI,GAAA,EAAK,CAAA,GAAI,CAAA;;;iBCDpC,OAAA,OAAc,WAAA,GAAc,IAAA,EAAM,CAAA,EAAG,KAAA,aAAkB,CAAA,IAAK,KAAA,EAAO,QAAA,CAAS,CAAA,MAAO,GAAA,CAAI,CAAA,EAAG,CAAA;AAAA,iBAC1F,OAAA,OAAc,KAAA,EAAO,QAAA,CAAS,CAAA,GAAI,WAAA,GAAc,IAAA,EAAM,CAAA,EAAG,KAAA,aAAkB,CAAA,GAAI,GAAA,CAAI,CAAA,EAAG,CAAA;;;iBCPtF,IAAA,OAAW,IAAA,EAAM,GAAA,CAAI,CAAA,EAAG,CAAA,IAAK,WAAA,CAAY,CAAA;;;;ANAzD;;iBOUgB,MAAA,IAAU,GAAA,EAAK,CAAA,OAAQ,IAAA,EAAM,GAAA,CAAI,CAAA,EAAG,CAAA,MAAO,GAAA,CAAI,CAAA,EAAG,CAAA;AAAA,iBAClD,MAAA,OAAa,IAAA,EAAM,GAAA,CAAI,CAAA,EAAG,CAAA,GAAI,GAAA,EAAK,CAAA,GAAI,GAAA,CAAI,CAAA,EAAG,CAAA;;;iBCL9C,GAAA,OAAU,GAAA,EAAK,CAAA,EAAG,KAAA,EAAO,CAAA,IAAK,IAAA,EAAM,GAAA,CAAI,CAAA,EAAG,CAAA,MAAO,GAAA,CAAI,CAAA,EAAG,CAAA;AAAA,iBACzD,GAAA,OAAU,IAAA,EAAM,GAAA,CAAI,CAAA,EAAG,CAAA,GAAI,GAAA,EAAK,CAAA,EAAG,KAAA,EAAO,CAAA,GAAI,GAAA,CAAI,CAAA,EAAG,CAAA;;;iBCPrD,MAAA,OAAa,IAAA,EAAM,GAAA,CAAI,CAAA,EAAG,CAAA,IAAK,WAAA,CAAY,CAAA"}
+{"version":3,"file":"index.d.cts","names":[],"sources":["../../src/map/_globalAliases.ts","../../src/map/clear.ts","../../src/map/entries.ts","../../src/map/forEach.ts","../../src/map/from.ts","../../src/map/get.ts","../../src/map/getOrInsert.ts","../../src/map/groupBy.ts","../../src/map/keys.ts","../../src/map/remove.ts","../../src/map/set.ts","../../src/map/values.ts"],"mappings":";;AAIA;;;cAAa,IAAA,EAAI,cAAM;;;;AAAvB;;;;AAAuB;;;iBCIP,KAAA,OAAY,IAAA,EAAM,GAAA,CAAI,CAAA,EAAG,CAAA,IAAK,GAAA,CAAI,CAAA,EAAG,CAAA;;;;ADJrD;;;;AAAuB;;;iBEIP,OAAA,OAAc,IAAA,EAAM,GAAA,CAAI,CAAA,EAAG,CAAA,IAAK,WAAA,EAAa,CAAA,EAAG,CAAA;;;;AFJhE;;;;AAAuB;;;;ACIvB;iBEYgB,OAAA,OAAc,UAAA,GAAa,KAAA,EAAO,CAAA,EAAG,GAAA,EAAK,CAAA,EAAG,GAAA,EAAK,GAAA,CAAI,CAAA,EAAG,CAAA,cAAe,IAAA,EAAM,GAAA,CAAI,CAAA,EAAG,CAAA,MAAO,GAAA,CAAI,CAAA,EAAG,CAAA;AAAA,iBACnG,OAAA,OAAc,IAAA,EAAM,GAAA,CAAI,CAAA,EAAG,CAAA,GAAI,UAAA,GAAa,KAAA,EAAO,CAAA,EAAG,GAAA,EAAK,CAAA,EAAG,GAAA,EAAK,GAAA,CAAI,CAAA,EAAG,CAAA,aAAc,GAAA,CAAI,CAAA,EAAG,CAAA;;;;AHjB/G;;;;AAAuB;;;iBIIP,IAAA,OAAW,QAAA,EAAU,QAAA,EAAU,CAAA,EAAG,CAAA,yBAA0B,CAAA,EAAG,CAAA,OAAQ,GAAA,CAAI,CAAA,EAAG,CAAA;AHA9F;;;;;;;;AAAA,iBGYgB,KAAA,UAAe,GAAA,CAAI,CAAA,EAAG,CAAA;;;;AJhBtC;;;;AAAuB;;;;ACIvB;;iBISgB,GAAA,IAAO,GAAA,EAAK,CAAA,OAAQ,IAAA,EAAM,GAAA,CAAI,CAAA,EAAG,CAAA,MAAO,CAAA;AAAA,iBACxC,GAAA,OAAU,IAAA,EAAM,GAAA,CAAI,CAAA,EAAG,CAAA,GAAI,GAAA,EAAK,CAAA,GAAI,CAAA;;;;ALdpD;;;;AAAuB;;;;ACIvB;iBKKgB,WAAA,OAAkB,GAAA,EAAK,GAAA,CAAI,CAAA,EAAG,CAAA,GAAI,GAAA,EAAK,CAAA,EAAG,YAAA,EAAc,CAAA,GAAI,GAAA,CAAI,CAAA,EAAG,CAAA;;;;;;;;;;;iBAenE,mBAAA,OAA0B,GAAA,EAAK,GAAA,CAAI,CAAA,EAAG,CAAA,GAAI,GAAA,EAAK,CAAA,EAAG,QAAA,GAAW,GAAA,EAAK,CAAA,KAAM,CAAA,GAAI,GAAA,CAAI,CAAA,EAAG,CAAA;;;;ANxBnG;;;;AAAuB;;;;ACIvB;;;iBMUgB,OAAA,OAAc,WAAA,GAAc,IAAA,EAAM,CAAA,EAAG,KAAA,aAAkB,CAAA,IAAK,KAAA,EAAO,QAAA,CAAS,CAAA,MAAO,GAAA,CAAI,CAAA,EAAG,CAAA;AAAA,iBAC1F,OAAA,OAAc,KAAA,EAAO,QAAA,CAAS,CAAA,GAAI,WAAA,GAAc,IAAA,EAAM,CAAA,EAAG,KAAA,aAAkB,CAAA,GAAI,GAAA,CAAI,CAAA,EAAG,CAAA;;;;APftG;;;;AAAuB;;;iBQIP,IAAA,OAAW,IAAA,EAAM,GAAA,CAAI,CAAA,EAAG,CAAA,IAAK,WAAA,CAAY,CAAA;;;;ARJzD;;;;AAAuB;;;;ACIvB;iBQSgB,MAAA,IAAU,GAAA,EAAK,CAAA,OAAQ,IAAA,EAAM,GAAA,CAAI,CAAA,EAAG,CAAA,MAAO,GAAA,CAAI,CAAA,EAAG,CAAA;AAAA,iBAClD,MAAA,OAAa,IAAA,EAAM,GAAA,CAAI,CAAA,EAAG,CAAA,GAAI,GAAA,EAAK,CAAA,GAAI,GAAA,CAAI,CAAA,EAAG,CAAA;;;;ATd9D;;;;AAAuB;;;;iBUWP,GAAA,OAAU,GAAA,EAAK,CAAA,EAAG,KAAA,EAAO,CAAA,IAAK,IAAA,EAAM,GAAA,CAAI,CAAA,EAAG,CAAA,MAAO,GAAA,CAAI,CAAA,EAAG,CAAA;AAAA,iBACzD,GAAA,OAAU,IAAA,EAAM,GAAA,CAAI,CAAA,EAAG,CAAA,GAAI,GAAA,EAAK,CAAA,EAAG,KAAA,EAAO,CAAA,GAAI,GAAA,CAAI,CAAA,EAAG,CAAA;;;;AVZrE;;;;AAAuB;;;iBWIP,MAAA,OAAa,IAAA,EAAM,GAAA,CAAI,CAAA,EAAG,CAAA,IAAK,WAAA,CAAY,CAAA"}

package/dist/map/index.d.mts

@@ -1,41 +1,169 @@
+//#region src/map/_globalAliases.d.ts
+/**
+ * Alias of the built-in map constructor. `new Map() === new Map.Ctor()`
+ * @function
+ */
+declare const Ctor: MapConstructor;
+//#endregion
 //#region src/map/clear.d.ts
+/**
+ * Removes all entries from a map and returns the same map.
+ *
+ * @example
+ * ```ts
+ * clear(new Map([['a', 1], ['b', 2]])); // Map(0) {}
+ * ```
+ */
 declare function clear<K, V>(data: Map<K, V>): Map<K, V>;
 //#endregion
 //#region src/map/entries.d.ts
+/**
+ * Returns an iterator of a map's key-value pairs.
+ *
+ * @example
+ * ```ts
+ * [...entries(new Map([['a', 1], ['b', 2]]))]; // [['a', 1], ['b', 2]]
+ * ```
+ */
 declare function entries<K, V>(data: Map<K, V>): MapIterator<[K, V]>;
 //#endregion
 //#region src/map/forEach.d.ts
+/**
+ * Runs a callback for each map entry and returns the same map.
+ *
+ * @example
+ * ```ts
+ * const map = new Map([['a', 1], ['b', 2]]);
+ * forEach(map, (value, key) => console.log(key, value)); // map
+ * forEach((value, key) => console.log(key, value))(map); // map
+ * ```
+ */
 declare function forEach<K, V>(callbackfn: (value: V, key: K, set: Map<K, V>) => void): (data: Map<K, V>) => Map<K, V>;
 declare function forEach<K, V>(data: Map<K, V>, callbackfn: (value: V, key: K, set: Map<K, V>) => void): Map<K, V>;
 //#endregion
 //#region src/map/from.d.ts
+/**
+ * Creates a map from an iterable of key-value pairs.
+ *
+ * @example
+ * ```ts
+ * from([['a', 1], ['b', 2]]); // Map { 'a' => 1, 'b' => 2 }
+ * ```
+ */
 declare function from<K, V>(iterable: Iterable<[K, V]> | readonly (readonly [K, V])[]): Map<K, V>;
+/**
+ * Creates an empty map.
+ *
+ * @example
+ * ```ts
+ * empty(); // Map(0) {}
+ * ```
+ */
 declare function empty<K, V>(): Map<K, V>;
 //#endregion
 //#region src/map/get.d.ts
+/**
+ * Returns the value associated with a key, or `undefined` when the key is absent.
+ *
+ * @example
+ * ```ts
+ * const map = new Map([['a', 1]]);
+ * get(map, 'a'); // 1
+ * get(map, 'b'); // undefined
+ * get('a')(map); // 1
+ * ```
+ */
 declare function get<K>(key: K): <V>(data: Map<K, V>) => V | undefined;
 declare function get<K, V>(data: Map<K, V>, key: K): V | undefined;
 //#endregion
+//#region src/map/getOrInsert.d.ts
+/**
+ * Inserts a default value when a key is absent and returns the same map.
+ *
+ * @example
+ * ```ts
+ * const map = new Map<string, number>();
+ * getOrInsert(map, 'a', 1); // Map { 'a' => 1 }
+ * getOrInsert(map, 'a', 2); // Map { 'a' => 1 }
+ * ```
+ */
+declare function getOrInsert<K, V>(map: Map<K, V>, key: K, defaultValue: V): Map<K, V>;
+/**
+ * Inserts a computed value when a key is absent and returns the same map.
+ *
+ * @example
+ * ```ts
+ * const map = new Map<string, number>();
+ * getOrInsertComputed(map, 'a', () => 1); // Map { 'a' => 1 }
+ * getOrInsertComputed(map, 'a', () => 2); // Map { 'a' => 1 }
+ * ```
+ */
+declare function getOrInsertComputed<K, V>(map: Map<K, V>, key: K, callback: (key: K) => V): Map<K, V>;
+//#endregion
 //#region src/map/groupBy.d.ts
+/**
+ * Groups iterable items into a map keyed by a selector function.
+ *
+ * @example
+ * ```ts
+ * groupBy(
+ *   [{ id: 1 }, { id: 2 }, { id: 1 }],
+ *   item => item.id,
+ * ); // Map { 1 => [{ id: 1 }, { id: 1 }], 2 => [{ id: 2 }] }
+ * groupBy(item => item.id)([{ id: 1 }, { id: 2 }]); // Map { 1 => [...], 2 => [...] }
+ * ```
+ */
 declare function groupBy<K, T>(keySelector: (item: T, index: number) => K): (items: Iterable<T>) => Map<K, T[]>;
 declare function groupBy<K, T>(items: Iterable<T>, keySelector: (item: T, index: number) => K): Map<K, T[]>;
 //#endregion
 //#region src/map/keys.d.ts
+/**
+ * Returns an iterator of a map's keys.
+ *
+ * @example
+ * ```ts
+ * [...keys(new Map([['a', 1], ['b', 2]]))]; // ['a', 'b']
+ * ```
+ */
 declare function keys<K, V>(data: Map<K, V>): MapIterator<K>;
 //#endregion
 //#region src/map/remove.d.ts
 /**
- * TODO: should this return a tuple?
+ * Removes an entry by key and returns the same map.
+ *
+ * @example
+ * ```ts
+ * const map = new Map([['a', 1], ['b', 2]]);
+ * remove(map, 'a'); // Map { 'b' => 2 }
+ * remove('b')(map); // Map(0) {}
+ * ```
  */
 declare function remove<K>(key: K): <V>(data: Map<K, V>) => Map<K, V>;
 declare function remove<K, V>(data: Map<K, V>, key: K): Map<K, V>;
 //#endregion
 //#region src/map/set.d.ts
+/**
+ * Sets a key-value pair and returns the same map.
+ *
+ * @example
+ * ```ts
+ * set(new Map(), 'a', 1); // Map { 'a' => 1 }
+ * set('b', 2)(new Map([['a', 1]])); // Map { 'a' => 1, 'b' => 2 }
+ * ```
+ */
 declare function set<K, V>(key: K, value: V): (data: Map<K, V>) => Map<K, V>;
 declare function set<K, V>(data: Map<K, V>, key: K, value: V): Map<K, V>;
 //#endregion
 //#region src/map/values.d.ts
+/**
+ * Returns an iterator of a map's values.
+ *
+ * @example
+ * ```ts
+ * [...values(new Map([['a', 1], ['b', 2]]))]; // [1, 2]
+ * ```
+ */
 declare function values<K, V>(data: Map<K, V>): MapIterator<V>;
 //#endregion
-export { clear, empty, entries, forEach, from, get, groupBy, keys, remove, set, values };
+export { Ctor, clear, empty, entries, forEach, from, get, getOrInsert, getOrInsertComputed, groupBy, keys, remove, set, values };
 //# sourceMappingURL=index.d.mts.map

package/dist/map/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","names":[],"sources":["../../src/map/clear.ts","../../src/map/entries.ts","../../src/map/forEach.ts","../../src/map/from.ts","../../src/map/get.ts","../../src/map/groupBy.ts","../../src/map/keys.ts","../../src/map/remove.ts","../../src/map/set.ts","../../src/map/values.ts"],"mappings":";iBAAgB,KAAA,OAAY,IAAA,EAAM,GAAA,CAAI,CAAA,EAAG,CAAA,IAAK,GAAA,CAAI,CAAA,EAAG,CAAA;;;iBCArC,OAAA,OAAc,IAAA,EAAM,GAAA,CAAI,CAAA,EAAG,CAAA,IAAK,WAAA,EAAa,CAAA,EAAG,CAAA;;;iBCUhD,OAAA,OAAc,UAAA,GAAa,KAAA,EAAO,CAAA,EAAG,GAAA,EAAK,CAAA,EAAG,GAAA,EAAK,GAAA,CAAI,CAAA,EAAG,CAAA,cAAe,IAAA,EAAM,GAAA,CAAI,CAAA,EAAG,CAAA,MAAO,GAAA,CAAI,CAAA,EAAG,CAAA;AAAA,iBACnG,OAAA,OAAc,IAAA,EAAM,GAAA,CAAI,CAAA,EAAG,CAAA,GAAI,UAAA,GAAa,KAAA,EAAO,CAAA,EAAG,GAAA,EAAK,CAAA,EAAG,GAAA,EAAK,GAAA,CAAI,CAAA,EAAG,CAAA,aAAc,GAAA,CAAI,CAAA,EAAG,CAAA;;;iBCX/F,IAAA,OAAW,QAAA,EAAU,QAAA,EAAU,CAAA,EAAG,CAAA,yBAA0B,CAAA,EAAG,CAAA,OAAQ,GAAA,CAAI,CAAA,EAAG,CAAA;AAAA,iBAI9E,KAAA,UAAe,GAAA,CAAI,CAAA,EAAG,CAAA;;;iBCEtB,GAAA,IAAO,GAAA,EAAK,CAAA,OAAQ,IAAA,EAAM,GAAA,CAAI,CAAA,EAAG,CAAA,MAAO,CAAA;AAAA,iBACxC,GAAA,OAAU,IAAA,EAAM,GAAA,CAAI,CAAA,EAAG,CAAA,GAAI,GAAA,EAAK,CAAA,GAAI,CAAA;;;iBCDpC,OAAA,OAAc,WAAA,GAAc,IAAA,EAAM,CAAA,EAAG,KAAA,aAAkB,CAAA,IAAK,KAAA,EAAO,QAAA,CAAS,CAAA,MAAO,GAAA,CAAI,CAAA,EAAG,CAAA;AAAA,iBAC1F,OAAA,OAAc,KAAA,EAAO,QAAA,CAAS,CAAA,GAAI,WAAA,GAAc,IAAA,EAAM,CAAA,EAAG,KAAA,aAAkB,CAAA,GAAI,GAAA,CAAI,CAAA,EAAG,CAAA;;;iBCPtF,IAAA,OAAW,IAAA,EAAM,GAAA,CAAI,CAAA,EAAG,CAAA,IAAK,WAAA,CAAY,CAAA;;;;ANAzD;;iBOUgB,MAAA,IAAU,GAAA,EAAK,CAAA,OAAQ,IAAA,EAAM,GAAA,CAAI,CAAA,EAAG,CAAA,MAAO,GAAA,CAAI,CAAA,EAAG,CAAA;AAAA,iBAClD,MAAA,OAAa,IAAA,EAAM,GAAA,CAAI,CAAA,EAAG,CAAA,GAAI,GAAA,EAAK,CAAA,GAAI,GAAA,CAAI,CAAA,EAAG,CAAA;;;iBCL9C,GAAA,OAAU,GAAA,EAAK,CAAA,EAAG,KAAA,EAAO,CAAA,IAAK,IAAA,EAAM,GAAA,CAAI,CAAA,EAAG,CAAA,MAAO,GAAA,CAAI,CAAA,EAAG,CAAA;AAAA,iBACzD,GAAA,OAAU,IAAA,EAAM,GAAA,CAAI,CAAA,EAAG,CAAA,GAAI,GAAA,EAAK,CAAA,EAAG,KAAA,EAAO,CAAA,GAAI,GAAA,CAAI,CAAA,EAAG,CAAA;;;iBCPrD,MAAA,OAAa,IAAA,EAAM,GAAA,CAAI,CAAA,EAAG,CAAA,IAAK,WAAA,CAAY,CAAA"}
+{"version":3,"file":"index.d.mts","names":[],"sources":["../../src/map/_globalAliases.ts","../../src/map/clear.ts","../../src/map/entries.ts","../../src/map/forEach.ts","../../src/map/from.ts","../../src/map/get.ts","../../src/map/getOrInsert.ts","../../src/map/groupBy.ts","../../src/map/keys.ts","../../src/map/remove.ts","../../src/map/set.ts","../../src/map/values.ts"],"mappings":";;AAIA;;;cAAa,IAAA,EAAI,cAAM;;;;AAAvB;;;;AAAuB;;;iBCIP,KAAA,OAAY,IAAA,EAAM,GAAA,CAAI,CAAA,EAAG,CAAA,IAAK,GAAA,CAAI,CAAA,EAAG,CAAA;;;;ADJrD;;;;AAAuB;;;iBEIP,OAAA,OAAc,IAAA,EAAM,GAAA,CAAI,CAAA,EAAG,CAAA,IAAK,WAAA,EAAa,CAAA,EAAG,CAAA;;;;AFJhE;;;;AAAuB;;;;ACIvB;iBEYgB,OAAA,OAAc,UAAA,GAAa,KAAA,EAAO,CAAA,EAAG,GAAA,EAAK,CAAA,EAAG,GAAA,EAAK,GAAA,CAAI,CAAA,EAAG,CAAA,cAAe,IAAA,EAAM,GAAA,CAAI,CAAA,EAAG,CAAA,MAAO,GAAA,CAAI,CAAA,EAAG,CAAA;AAAA,iBACnG,OAAA,OAAc,IAAA,EAAM,GAAA,CAAI,CAAA,EAAG,CAAA,GAAI,UAAA,GAAa,KAAA,EAAO,CAAA,EAAG,GAAA,EAAK,CAAA,EAAG,GAAA,EAAK,GAAA,CAAI,CAAA,EAAG,CAAA,aAAc,GAAA,CAAI,CAAA,EAAG,CAAA;;;;AHjB/G;;;;AAAuB;;;iBIIP,IAAA,OAAW,QAAA,EAAU,QAAA,EAAU,CAAA,EAAG,CAAA,yBAA0B,CAAA,EAAG,CAAA,OAAQ,GAAA,CAAI,CAAA,EAAG,CAAA;AHA9F;;;;;;;;AAAA,iBGYgB,KAAA,UAAe,GAAA,CAAI,CAAA,EAAG,CAAA;;;;AJhBtC;;;;AAAuB;;;;ACIvB;;iBISgB,GAAA,IAAO,GAAA,EAAK,CAAA,OAAQ,IAAA,EAAM,GAAA,CAAI,CAAA,EAAG,CAAA,MAAO,CAAA;AAAA,iBACxC,GAAA,OAAU,IAAA,EAAM,GAAA,CAAI,CAAA,EAAG,CAAA,GAAI,GAAA,EAAK,CAAA,GAAI,CAAA;;;;ALdpD;;;;AAAuB;;;;ACIvB;iBKKgB,WAAA,OAAkB,GAAA,EAAK,GAAA,CAAI,CAAA,EAAG,CAAA,GAAI,GAAA,EAAK,CAAA,EAAG,YAAA,EAAc,CAAA,GAAI,GAAA,CAAI,CAAA,EAAG,CAAA;;;;;;;;;;;iBAenE,mBAAA,OAA0B,GAAA,EAAK,GAAA,CAAI,CAAA,EAAG,CAAA,GAAI,GAAA,EAAK,CAAA,EAAG,QAAA,GAAW,GAAA,EAAK,CAAA,KAAM,CAAA,GAAI,GAAA,CAAI,CAAA,EAAG,CAAA;;;;ANxBnG;;;;AAAuB;;;;ACIvB;;;iBMUgB,OAAA,OAAc,WAAA,GAAc,IAAA,EAAM,CAAA,EAAG,KAAA,aAAkB,CAAA,IAAK,KAAA,EAAO,QAAA,CAAS,CAAA,MAAO,GAAA,CAAI,CAAA,EAAG,CAAA;AAAA,iBAC1F,OAAA,OAAc,KAAA,EAAO,QAAA,CAAS,CAAA,GAAI,WAAA,GAAc,IAAA,EAAM,CAAA,EAAG,KAAA,aAAkB,CAAA,GAAI,GAAA,CAAI,CAAA,EAAG,CAAA;;;;APftG;;;;AAAuB;;;iBQIP,IAAA,OAAW,IAAA,EAAM,GAAA,CAAI,CAAA,EAAG,CAAA,IAAK,WAAA,CAAY,CAAA;;;;ARJzD;;;;AAAuB;;;;ACIvB;iBQSgB,MAAA,IAAU,GAAA,EAAK,CAAA,OAAQ,IAAA,EAAM,GAAA,CAAI,CAAA,EAAG,CAAA,MAAO,GAAA,CAAI,CAAA,EAAG,CAAA;AAAA,iBAClD,MAAA,OAAa,IAAA,EAAM,GAAA,CAAI,CAAA,EAAG,CAAA,GAAI,GAAA,EAAK,CAAA,GAAI,GAAA,CAAI,CAAA,EAAG,CAAA;;;;ATd9D;;;;AAAuB;;;;iBUWP,GAAA,OAAU,GAAA,EAAK,CAAA,EAAG,KAAA,EAAO,CAAA,IAAK,IAAA,EAAM,GAAA,CAAI,CAAA,EAAG,CAAA,MAAO,GAAA,CAAI,CAAA,EAAG,CAAA;AAAA,iBACzD,GAAA,OAAU,IAAA,EAAM,GAAA,CAAI,CAAA,EAAG,CAAA,GAAI,GAAA,EAAK,CAAA,EAAG,KAAA,EAAO,CAAA,GAAI,GAAA,CAAI,CAAA,EAAG,CAAA;;;;AVZrE;;;;AAAuB;;;iBWIP,MAAA,OAAa,IAAA,EAAM,GAAA,CAAI,CAAA,EAAG,CAAA,IAAK,WAAA,CAAY,CAAA"}

package/dist/map/index.mjs

@@ -1,11 +1,35 @@
-import { t as purry } from "../purry-BOWmqwDB.mjs";
+import { t as purry } from "../purry-DXnhXie9.mjs";
+import { a as NotYetImplementedError } from "../errors-Dw1kitu_.mjs";
+//#region src/map/_globalAliases.ts
+/**
+* Alias of the built-in map constructor. `new Map() === new Map.Ctor()`
+* @function
+*/
+const Ctor = Map;
+//#endregion
 //#region src/map/clear.ts
+/**
+* Removes all entries from a map and returns the same map.
+*
+* @example
+* ```ts
+* clear(new Map([['a', 1], ['b', 2]])); // Map(0) {}
+* ```
+*/
 function clear(data) {
 	data.clear();
 	return data;
 }
 //#endregion
 //#region src/map/entries.ts
+/**
+* Returns an iterator of a map's key-value pairs.
+*
+* @example
+* ```ts
+* [...entries(new Map([['a', 1], ['b', 2]]))]; // [['a', 1], ['b', 2]]
+* ```
+*/
 function entries(data) {
 	return data.entries();
 }
@@ -20,9 +44,25 @@ function forEach(...args) {
 }
 //#endregion
 //#region src/map/from.ts
+/**
+* Creates a map from an iterable of key-value pairs.
+*
+* @example
+* ```ts
+* from([['a', 1], ['b', 2]]); // Map { 'a' => 1, 'b' => 2 }
+* ```
+*/
 function from(iterable) {
 	return new Map(iterable);
 }
+/**
+* Creates an empty map.
+*
+* @example
+* ```ts
+* empty(); // Map(0) {}
+* ```
+*/
 function empty() {
 	return /* @__PURE__ */ new Map();
 }
@@ -35,6 +75,34 @@ function get(...args) {
 	return purry(getImplementation, args);
 }
 //#endregion
+//#region src/map/getOrInsert.ts
+/**
+* Inserts a default value when a key is absent and returns the same map.
+*
+* @example
+* ```ts
+* const map = new Map<string, number>();
+* getOrInsert(map, 'a', 1); // Map { 'a' => 1 }
+* getOrInsert(map, 'a', 2); // Map { 'a' => 1 }
+* ```
+*/
+function getOrInsert(map, key, defaultValue) {
+	throw new NotYetImplementedError("M.getOrInsert not yet implemented");
+}
+/**
+* Inserts a computed value when a key is absent and returns the same map.
+*
+* @example
+* ```ts
+* const map = new Map<string, number>();
+* getOrInsertComputed(map, 'a', () => 1); // Map { 'a' => 1 }
+* getOrInsertComputed(map, 'a', () => 2); // Map { 'a' => 1 }
+* ```
+*/
+function getOrInsertComputed(map, key, callback) {
+	throw new NotYetImplementedError("M.getOrInsertComputed not yet implemented");
+}
+//#endregion
 //#region src/map/groupBy.ts
 function groupByImplementation(items, keySelector) {
 	return Map.groupBy(items, keySelector);
@@ -44,6 +112,14 @@ function groupBy(...args) {
 }
 //#endregion
 //#region src/map/keys.ts
+/**
+* Returns an iterator of a map's keys.
+*
+* @example
+* ```ts
+* [...keys(new Map([['a', 1], ['b', 2]]))]; // ['a', 'b']
+* ```
+*/
 function keys(data) {
 	return data.keys();
 }
@@ -66,10 +142,18 @@ function set(...args) {
 }
 //#endregion
 //#region src/map/values.ts
+/**
+* Returns an iterator of a map's values.
+*
+* @example
+* ```ts
+* [...values(new Map([['a', 1], ['b', 2]]))]; // [1, 2]
+* ```
+*/
 function values(data) {
 	return data.values();
 }
 //#endregion
-export { clear, empty, entries, forEach, from, get, groupBy, keys, remove, set, values };
+export { Ctor, clear, empty, entries, forEach, from, get, getOrInsert, getOrInsertComputed, groupBy, keys, remove, set, values };
 
 //# sourceMappingURL=index.mjs.map