@sapphire/iterator-utilities 1.0.3-next.fc35dd86 → 2.0.0-next.1e7d2dec

package/dist/esm/lib/greaterOrEqualThan.mjs

@@ -0,0 +1,13 @@
+import { __name } from '../chunk-PAWJFY3S.mjs';
+import { compare } from './compare.mjs';
+import { orderingIsLess } from './shared/_compare.mjs';
+
+function greaterOrEqualThan(iterable, other) {
+  const result = compare(iterable, other);
+  return !orderingIsLess(result);
+}
+__name(greaterOrEqualThan, "greaterOrEqualThan");
+
+export { greaterOrEqualThan as ge, greaterOrEqualThan };
+//# sourceMappingURL=greaterOrEqualThan.mjs.map
+//# sourceMappingURL=greaterOrEqualThan.mjs.map

package/dist/esm/lib/greaterOrEqualThan.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/lib/greaterOrEqualThan.ts"],"names":[],"mappings":";;;;AA+BO,SAAS,kBAAA,CAAsC,UAA2C,KAAiD,EAAA;AACjJ,EAAM,MAAA,MAAA,GAAS,OAAQ,CAAA,QAAA,EAAU,KAAK,CAAA,CAAA;AACtC,EAAO,OAAA,CAAC,eAAe,MAAM,CAAA,CAAA;AAC9B,CAAA;AAHgB,MAAA,CAAA,kBAAA,EAAA,oBAAA,CAAA","file":"greaterOrEqualThan.mjs","sourcesContent":["import { compare } from './compare';\nimport type { IterableResolvable } from './from';\nimport { orderingIsLess, type LexicographicComparison } from './shared/_compare';\n\n/**\n * Determines if the elements of `iterable` are {@link LexicographicComparison lexicographically} greater or equal than\n * those of another.\n *\n * @param iterable The iterator to compare.\n * @param other The iterator to compare against.\n *\n * @example\n * ```typescript\n * import { greaterOrEqualThan } from '@sapphire/iterator-utilities';\n *\n * const x = [1, 2, 3, 4];\n * const y = [1, 4, 9, 16];\n * console.log(greaterOrEqualThan([1], [1]));\n * // Output: true\n * console.log(greaterOrEqualThan([1], [1, 2]));\n * // Output: false\n * console.log(greaterOrEqualThan([1, 2], [1]));\n * // Output: true\n * console.log(greaterOrEqualThan([1, 2], [1, 2]));\n * // Output: true\n * ```\n *\n * @remarks\n *\n * This function consumes the entire iterator.\n */\nexport function greaterOrEqualThan<const ElementType>(iterable: IterableResolvable<ElementType>, other: IterableResolvable<ElementType>): boolean {\n\tconst result = compare(iterable, other);\n\treturn !orderingIsLess(result);\n}\n\nexport { greaterOrEqualThan as ge };\n"]}

package/dist/esm/lib/greaterThan.d.mts

@@ -0,0 +1,32 @@
+import { IterableResolvable } from './from.mjs';
+
+/**
+ * Determines if the elements of `iterable` are {@link LexicographicComparison lexicographically} greater than those of
+ * another.
+ *
+ * @param iterable The iterator to compare.
+ * @param other The iterator to compare against.
+ *
+ * @example
+ * ```typescript
+ * import { greaterThan } from '@sapphire/iterator-utilities';
+ *
+ * const x = [1, 2, 3, 4];
+ * const y = [1, 4, 9, 16];
+ * console.log(greaterThan([1], [1]));
+ * // Output: false
+ * console.log(greaterThan([1], [1, 2]));
+ * // Output: false
+ * console.log(greaterThan([1, 2], [1]));
+ * // Output: true
+ * console.log(greaterThan([1, 2], [1, 2]));
+ * // Output: false
+ * ```
+ *
+ * @remarks
+ *
+ * This function consumes the entire iterator.
+ */
+declare function greaterThan<const ElementType>(iterable: IterableResolvable<ElementType>, other: IterableResolvable<ElementType>): boolean;
+
+export { greaterThan, greaterThan as gt };

package/dist/esm/lib/greaterThan.mjs

@@ -0,0 +1,13 @@
+import { __name } from '../chunk-PAWJFY3S.mjs';
+import { compare } from './compare.mjs';
+import { orderingIsGreater } from './shared/_compare.mjs';
+
+function greaterThan(iterable, other) {
+  const result = compare(iterable, other);
+  return orderingIsGreater(result);
+}
+__name(greaterThan, "greaterThan");
+
+export { greaterThan, greaterThan as gt };
+//# sourceMappingURL=greaterThan.mjs.map
+//# sourceMappingURL=greaterThan.mjs.map

package/dist/esm/lib/greaterThan.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/lib/greaterThan.ts"],"names":[],"mappings":";;;;AA+BO,SAAS,WAAA,CAA+B,UAA2C,KAAiD,EAAA;AAC1I,EAAM,MAAA,MAAA,GAAS,OAAQ,CAAA,QAAA,EAAU,KAAK,CAAA,CAAA;AACtC,EAAA,OAAO,kBAAkB,MAAM,CAAA,CAAA;AAChC,CAAA;AAHgB,MAAA,CAAA,WAAA,EAAA,aAAA,CAAA","file":"greaterThan.mjs","sourcesContent":["import { compare } from './compare';\nimport type { IterableResolvable } from './from';\nimport { orderingIsGreater, type LexicographicComparison } from './shared/_compare';\n\n/**\n * Determines if the elements of `iterable` are {@link LexicographicComparison lexicographically} greater than those of\n * another.\n *\n * @param iterable The iterator to compare.\n * @param other The iterator to compare against.\n *\n * @example\n * ```typescript\n * import { greaterThan } from '@sapphire/iterator-utilities';\n *\n * const x = [1, 2, 3, 4];\n * const y = [1, 4, 9, 16];\n * console.log(greaterThan([1], [1]));\n * // Output: false\n * console.log(greaterThan([1], [1, 2]));\n * // Output: false\n * console.log(greaterThan([1, 2], [1]));\n * // Output: true\n * console.log(greaterThan([1, 2], [1, 2]));\n * // Output: false\n * ```\n *\n * @remarks\n *\n * This function consumes the entire iterator.\n */\nexport function greaterThan<const ElementType>(iterable: IterableResolvable<ElementType>, other: IterableResolvable<ElementType>): boolean {\n\tconst result = compare(iterable, other);\n\treturn orderingIsGreater(result);\n}\n\nexport { greaterThan as gt };\n"]}

package/dist/esm/lib/indexOf.d.mts

@@ -22,4 +22,4 @@ import { IterableResolvable } from './from.mjs';
  */
 declare function indexOf<const ElementType>(iterable: IterableResolvable<ElementType>, value: ElementType): number;
 
-export { indexOf, indexOf as position };
+export { indexOf };

package/dist/esm/lib/indexOf.mjs

@@ -13,6 +13,6 @@ function indexOf(iterable, value) {
 }
 __name(indexOf, "indexOf");
 
-export { indexOf, indexOf as position };
+export { indexOf };
 //# sourceMappingURL=indexOf.mjs.map
 //# sourceMappingURL=indexOf.mjs.map

package/dist/esm/lib/indexOf.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/lib/indexOf.ts"],"names":[],"mappings":";;;AAuBO,SAAS,OAAA,CAA2B,UAA2C,KAA4B,EAAA;AACjH,EAAA,IAAI,KAAQ,GAAA,CAAA,CAAA;AACZ,EAAW,KAAA,MAAA,OAAA,IAAW,kBAAmB,CAAA,QAAQ,CAAG,EAAA;AACnD,IAAA,IAAI,YAAY,KAAO,EAAA;AACtB,MAAO,OAAA,KAAA,CAAA;AAAA,KACR;AAEA,IAAA,KAAA,EAAA,CAAA;AAAA,GACD;AAEA,EAAO,OAAA,CAAA,CAAA,CAAA;AACR,CAAA;AAXgB,MAAA,CAAA,OAAA,EAAA,SAAA,CAAA","file":"indexOf.mjs","sourcesContent":["import type { IterableResolvable } from './from';\nimport { toIterableIterator } from './toIterableIterator';\n\n/**\n * Advances the iterable until it finds the element, returning its index if it's found and `-1` otherwise.\n *\n * @param iterable An iterator to search for a value in.\n * @param value The value to search for.\n * @returns The index of the first occurrence of the value in the iterator, or `-1` if the value is not found.\n *\n * @example\n * ```typescript\n * import { indexOf } from '@sapphire/iterator-utilities';\n *\n * const iterable = [1, 2, 3, 4, 5];\n * console.log(indexOf(iterable, 3));\n * // Output: 2\n * ```\n *\n * @remarks\n *\n * This function consumes the iterator until the value is found or the iterator is exhausted.\n */\nexport function indexOf<const ElementType>(iterable: IterableResolvable<ElementType>, value: ElementType): number {\n\tlet index = 0;\n\tfor (const element of toIterableIterator(iterable)) {\n\t\tif (element === value) {\n\t\t\treturn index;\n\t\t}\n\n\t\tindex++;\n\t}\n\n\treturn -1;\n}\n\nexport { indexOf as position };\n"]}
+{"version":3,"sources":["../../../src/lib/indexOf.ts"],"names":[],"mappings":";;;AAuBO,SAAS,OAAA,CAA2B,UAA2C,KAA4B,EAAA;AACjH,EAAA,IAAI,KAAQ,GAAA,CAAA,CAAA;AACZ,EAAW,KAAA,MAAA,OAAA,IAAW,kBAAmB,CAAA,QAAQ,CAAG,EAAA;AACnD,IAAA,IAAI,YAAY,KAAO,EAAA;AACtB,MAAO,OAAA,KAAA,CAAA;AAAA,KACR;AAEA,IAAA,KAAA,EAAA,CAAA;AAAA,GACD;AAEA,EAAO,OAAA,CAAA,CAAA,CAAA;AACR,CAAA;AAXgB,MAAA,CAAA,OAAA,EAAA,SAAA,CAAA","file":"indexOf.mjs","sourcesContent":["import type { IterableResolvable } from './from';\nimport { toIterableIterator } from './toIterableIterator';\n\n/**\n * Advances the iterable until it finds the element, returning its index if it's found and `-1` otherwise.\n *\n * @param iterable An iterator to search for a value in.\n * @param value The value to search for.\n * @returns The index of the first occurrence of the value in the iterator, or `-1` if the value is not found.\n *\n * @example\n * ```typescript\n * import { indexOf } from '@sapphire/iterator-utilities';\n *\n * const iterable = [1, 2, 3, 4, 5];\n * console.log(indexOf(iterable, 3));\n * // Output: 2\n * ```\n *\n * @remarks\n *\n * This function consumes the iterator until the value is found or the iterator is exhausted.\n */\nexport function indexOf<const ElementType>(iterable: IterableResolvable<ElementType>, value: ElementType): number {\n\tlet index = 0;\n\tfor (const element of toIterableIterator(iterable)) {\n\t\tif (element === value) {\n\t\t\treturn index;\n\t\t}\n\n\t\tindex++;\n\t}\n\n\treturn -1;\n}\n"]}

package/dist/esm/lib/inspect.d.mts

@@ -0,0 +1,39 @@
+import { IterableResolvable } from './from.mjs';
+
+/**
+ * Does something with each element of an iterator, passing the value on.
+ *
+ * When using iterators, you'll often chain several of them together. While working on such code, you might want to
+ * check out what's happening at various parts in the pipeline. To do that, insert a call to this function.
+ *
+ * It's more common for this function to be used as a debugging tool than to exist in your final code, but applications
+ * may find it useful in certain situations when errors need to be logged before being discarded.
+ *
+ * @param iterable An iterator to inspect.
+ *
+ * @example
+ * ```typescript
+ * import { inspect } from '@sapphire/iterator-utilities';
+ *
+ * const iterable = [1, 4, 2, 3];
+ *
+ * let iter = inspect(iter, (value) => console.log(`about to filter: ${value}`));
+ * iter = filter(iterable, (value) => value % 2 === 0);
+ * iter = inspect(iter, (value) => console.log(`made it through filter: ${value}`));
+ *
+ * const sum = reduce(iter, (acc, value) => acc + value, 0);
+ * console.log(sum);
+ *
+ * // Output:
+ * // about to filter: 1
+ * // about to filter: 4
+ * // made it through filter: 4
+ * // about to filter: 2
+ * // made it through filter: 2
+ * // about to filter: 3
+ * // 6
+ * ```
+ */
+declare function inspect<const ElementType>(iterable: IterableResolvable<ElementType>, callbackFn: (element: ElementType, index: number) => void): IterableIterator<ElementType>;
+
+export { inspect };

package/dist/esm/lib/inspect.mjs

@@ -0,0 +1,22 @@
+import { __name } from '../chunk-PAWJFY3S.mjs';
+import { from } from './from.mjs';
+import { assertFunction } from './shared/_assertFunction.mjs';
+import { makeIterableIterator } from './shared/_makeIterableIterator.mjs';
+
+function inspect(iterable, callbackFn) {
+  callbackFn = assertFunction(callbackFn);
+  let index = 0;
+  const iterator = from(iterable);
+  return makeIterableIterator(() => {
+    const result = iterator.next();
+    if (!result.done) {
+      callbackFn(result.value, index++);
+    }
+    return result;
+  });
+}
+__name(inspect, "inspect");
+
+export { inspect };
+//# sourceMappingURL=inspect.mjs.map
+//# sourceMappingURL=inspect.mjs.map

package/dist/esm/lib/inspect.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/lib/inspect.ts"],"names":[],"mappings":";;;;;AAsCO,SAAS,OAAA,CACf,UACA,UACgC,EAAA;AAChC,EAAA,UAAA,GAAa,eAAe,UAAU,CAAA,CAAA;AAEtC,EAAA,IAAI,KAAQ,GAAA,CAAA,CAAA;AACZ,EAAM,MAAA,QAAA,GAAW,KAAK,QAAQ,CAAA,CAAA;AAC9B,EAAA,OAAO,qBAAkC,MAAM;AAC9C,IAAM,MAAA,MAAA,GAAS,SAAS,IAAK,EAAA,CAAA;AAC7B,IAAI,IAAA,CAAC,OAAO,IAAM,EAAA;AACjB,MAAW,UAAA,CAAA,MAAA,CAAO,OAAO,KAAO,EAAA,CAAA,CAAA;AAAA,KACjC;AAEA,IAAO,OAAA,MAAA,CAAA;AAAA,GACP,CAAA,CAAA;AACF,CAAA;AAhBgB,MAAA,CAAA,OAAA,EAAA,SAAA,CAAA","file":"inspect.mjs","sourcesContent":["import { from, type IterableResolvable } from './from';\nimport { assertFunction } from './shared/_assertFunction';\nimport { makeIterableIterator } from './shared/_makeIterableIterator';\n\n/**\n * Does something with each element of an iterator, passing the value on.\n *\n * When using iterators, you'll often chain several of them together. While working on such code, you might want to\n * check out what's happening at various parts in the pipeline. To do that, insert a call to this function.\n *\n * It's more common for this function to be used as a debugging tool than to exist in your final code, but applications\n * may find it useful in certain situations when errors need to be logged before being discarded.\n *\n * @param iterable An iterator to inspect.\n *\n * @example\n * ```typescript\n * import { inspect } from '@sapphire/iterator-utilities';\n *\n * const iterable = [1, 4, 2, 3];\n *\n * let iter = inspect(iter, (value) => console.log(`about to filter: ${value}`));\n * iter = filter(iterable, (value) => value % 2 === 0);\n * iter = inspect(iter, (value) => console.log(`made it through filter: ${value}`));\n *\n * const sum = reduce(iter, (acc, value) => acc + value, 0);\n * console.log(sum);\n *\n * // Output:\n * // about to filter: 1\n * // about to filter: 4\n * // made it through filter: 4\n * // about to filter: 2\n * // made it through filter: 2\n * // about to filter: 3\n * // 6\n * ```\n */\nexport function inspect<const ElementType>(\n\titerable: IterableResolvable<ElementType>,\n\tcallbackFn: (element: ElementType, index: number) => void\n): IterableIterator<ElementType> {\n\tcallbackFn = assertFunction(callbackFn);\n\n\tlet index = 0;\n\tconst iterator = from(iterable);\n\treturn makeIterableIterator<ElementType>(() => {\n\t\tconst result = iterator.next();\n\t\tif (!result.done) {\n\t\t\tcallbackFn(result.value, index++);\n\t\t}\n\n\t\treturn result;\n\t});\n}\n"]}

package/dist/esm/lib/intersperse.d.mts

@@ -0,0 +1,30 @@
+import { IterableResolvable } from './from.mjs';
+
+/**
+ * Creates a new iterator which places `separator` between adjacent items of the original iterator.
+ *
+ * @param iterable An iterator to map over.
+ * @param separator The separator to place between adjacent items.
+ *
+ * @example
+ * ```typescript
+ * import { intersperse } from '@sapphire/iterator-utilities';
+ *
+ * const iterable = [0, 1, 2];
+ * console.log([...intersperse(iterable, 100)]);
+ * // Output: [0, 100, 1, 100, 2]
+ * ```
+ *
+ * @example
+ * `intersperse` can be very useful to join an iterator's items using a common element:
+ * ```typescript
+ * import { intersperse } from '@sapphire/iterator-utilities';
+ *
+ * const iterable = ['Hello', 'World', '!'];
+ * console.log([...intersperse(iterable, ', ')].join(''));
+ * // Output: 'Hello, World, !'
+ * ```
+ */
+declare function intersperse<const ElementType>(iterable: IterableResolvable<ElementType>, separator: ElementType): IterableIterator<ElementType>;
+
+export { intersperse };

package/dist/esm/lib/intersperse.mjs

@@ -0,0 +1,32 @@
+import { __name } from '../chunk-PAWJFY3S.mjs';
+import { from } from './from.mjs';
+import { makeIterableIterator } from './shared/_makeIterableIterator.mjs';
+
+function intersperse(iterable, separator) {
+  let started = false;
+  let nextItem;
+  let nextItemTaken = false;
+  const iterator = from(iterable);
+  return makeIterableIterator(() => {
+    if (started) {
+      if (nextItemTaken) {
+        nextItemTaken = false;
+        return { done: false, value: nextItem };
+      }
+      const result = iterator.next();
+      if (result.done) {
+        return { done: true, value: void 0 };
+      }
+      nextItem = result.value;
+      nextItemTaken = true;
+      return { done: false, value: separator };
+    }
+    started = true;
+    return iterator.next();
+  });
+}
+__name(intersperse, "intersperse");
+
+export { intersperse };
+//# sourceMappingURL=intersperse.mjs.map
+//# sourceMappingURL=intersperse.mjs.map

package/dist/esm/lib/intersperse.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/lib/intersperse.ts"],"names":[],"mappings":";;;;AA4BO,SAAS,WAAA,CAA+B,UAA2C,SAAuD,EAAA;AAChJ,EAAA,IAAI,OAAU,GAAA,KAAA,CAAA;AACd,EAAI,IAAA,QAAA,CAAA;AACJ,EAAA,IAAI,aAAgB,GAAA,KAAA,CAAA;AAEpB,EAAM,MAAA,QAAA,GAAW,KAAK,QAAQ,CAAA,CAAA;AAC9B,EAAA,OAAO,qBAAkC,MAAM;AAC9C,IAAA,IAAI,OAAS,EAAA;AACZ,MAAA,IAAI,aAAe,EAAA;AAClB,QAAgB,aAAA,GAAA,KAAA,CAAA;AAChB,QAAA,OAAO,EAAE,IAAA,EAAM,KAAO,EAAA,KAAA,EAAO,QAAS,EAAA,CAAA;AAAA,OACvC;AAEA,MAAM,MAAA,MAAA,GAAS,SAAS,IAAK,EAAA,CAAA;AAC7B,MAAA,IAAI,OAAO,IAAM,EAAA;AAChB,QAAA,OAAO,EAAE,IAAA,EAAM,IAAM,EAAA,KAAA,EAAO,KAAU,CAAA,EAAA,CAAA;AAAA,OACvC;AAEA,MAAA,QAAA,GAAW,MAAO,CAAA,KAAA,CAAA;AAClB,MAAgB,aAAA,GAAA,IAAA,CAAA;AAChB,MAAA,OAAO,EAAE,IAAA,EAAM,KAAO,EAAA,KAAA,EAAO,SAAU,EAAA,CAAA;AAAA,KACxC;AAEA,IAAU,OAAA,GAAA,IAAA,CAAA;AACV,IAAA,OAAO,SAAS,IAAK,EAAA,CAAA;AAAA,GACrB,CAAA,CAAA;AACF,CAAA;AA1BgB,MAAA,CAAA,WAAA,EAAA,aAAA,CAAA","file":"intersperse.mjs","sourcesContent":["import { from, type IterableResolvable } from './from';\nimport { makeIterableIterator } from './shared/_makeIterableIterator';\n\n/**\n * Creates a new iterator which places `separator` between adjacent items of the original iterator.\n *\n * @param iterable An iterator to map over.\n * @param separator The separator to place between adjacent items.\n *\n * @example\n * ```typescript\n * import { intersperse } from '@sapphire/iterator-utilities';\n *\n * const iterable = [0, 1, 2];\n * console.log([...intersperse(iterable, 100)]);\n * // Output: [0, 100, 1, 100, 2]\n * ```\n *\n * @example\n * `intersperse` can be very useful to join an iterator's items using a common element:\n * ```typescript\n * import { intersperse } from '@sapphire/iterator-utilities';\n *\n * const iterable = ['Hello', 'World', '!'];\n * console.log([...intersperse(iterable, ', ')].join(''));\n * // Output: 'Hello, World, !'\n * ```\n */\nexport function intersperse<const ElementType>(iterable: IterableResolvable<ElementType>, separator: ElementType): IterableIterator<ElementType> {\n\tlet started = false;\n\tlet nextItem: ElementType;\n\tlet nextItemTaken = false;\n\n\tconst iterator = from(iterable);\n\treturn makeIterableIterator<ElementType>(() => {\n\t\tif (started) {\n\t\t\tif (nextItemTaken) {\n\t\t\t\tnextItemTaken = false;\n\t\t\t\treturn { done: false, value: nextItem };\n\t\t\t}\n\n\t\t\tconst result = iterator.next();\n\t\t\tif (result.done) {\n\t\t\t\treturn { done: true, value: undefined };\n\t\t\t}\n\n\t\t\tnextItem = result.value;\n\t\t\tnextItemTaken = true;\n\t\t\treturn { done: false, value: separator };\n\t\t}\n\n\t\tstarted = true;\n\t\treturn iterator.next();\n\t});\n}\n"]}

package/dist/esm/lib/isSorted.d.mts

@@ -0,0 +1,35 @@
+import { IterableResolvable } from './from.mjs';
+
+/**
+ * Checks if the elements of this iterator are sorted in ascending order.
+ *
+ * That is, for each element `a` and its following element `b`, `a <= b` must hold. If the iterator yields exactly zero
+ * or one element, `true` is returned.
+ *
+ * This function uses the default comparator (lexicographically), which means it will compare the elements as strings.
+ * If this is undesirable, use {@link isSortedBy} instead.
+ *
+ * @seealso {@link isSortedBy} for a version that allows custom comparators.
+ * @seealso {@link isSortedByKey} for a version that allows custom key extractors.
+ *
+ * @param iterable The iterator to compare.
+ *
+ * @example
+ * ```typescript
+ * import { isSorted } from '@sapphire/iterator-utilities';
+ *
+ * assert(isSorted([1, 2, 2, 9]);
+ * assert(!isSorted([1, 3, 2, 4]);
+ *
+ * assert(isSorted([0]);
+ * assert(isSorted([]);
+ * assert(isSorted([0, 1, NaN]);
+ * ```
+ *
+ * @remarks
+ *
+ * This function consumes the entire iterator.
+ */
+declare function isSorted<const ElementType>(iterable: IterableResolvable<ElementType>): boolean;
+
+export { isSorted };

package/dist/esm/lib/isSorted.mjs

@@ -0,0 +1,12 @@
+import { __name } from '../chunk-PAWJFY3S.mjs';
+import { isSortedBy } from './isSortedBy.mjs';
+import { defaultCompare } from './shared/comparators.mjs';
+
+function isSorted(iterable) {
+  return isSortedBy(iterable, defaultCompare);
+}
+__name(isSorted, "isSorted");
+
+export { isSorted };
+//# sourceMappingURL=isSorted.mjs.map
+//# sourceMappingURL=isSorted.mjs.map

package/dist/esm/lib/isSorted.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/lib/isSorted.ts"],"names":[],"mappings":";;;;AAmCO,SAAS,SAA4B,QAAoD,EAAA;AAC/F,EAAO,OAAA,UAAA,CAAW,UAAU,cAAc,CAAA,CAAA;AAC3C,CAAA;AAFgB,MAAA,CAAA,QAAA,EAAA,UAAA,CAAA","file":"isSorted.mjs","sourcesContent":["import type { IterableResolvable } from './from';\nimport { isSortedBy } from './isSortedBy';\nimport type { isSortedByKey } from './isSortedByKey';\nimport { defaultCompare } from './shared/comparators';\n\n/**\n * Checks if the elements of this iterator are sorted in ascending order.\n *\n * That is, for each element `a` and its following element `b`, `a <= b` must hold. If the iterator yields exactly zero\n * or one element, `true` is returned.\n *\n * This function uses the default comparator (lexicographically), which means it will compare the elements as strings.\n * If this is undesirable, use {@link isSortedBy} instead.\n *\n * @seealso {@link isSortedBy} for a version that allows custom comparators.\n * @seealso {@link isSortedByKey} for a version that allows custom key extractors.\n *\n * @param iterable The iterator to compare.\n *\n * @example\n * ```typescript\n * import { isSorted } from '@sapphire/iterator-utilities';\n *\n * assert(isSorted([1, 2, 2, 9]);\n * assert(!isSorted([1, 3, 2, 4]);\n *\n * assert(isSorted([0]);\n * assert(isSorted([]);\n * assert(isSorted([0, 1, NaN]);\n * ```\n *\n * @remarks\n *\n * This function consumes the entire iterator.\n */\nexport function isSorted<const ElementType>(iterable: IterableResolvable<ElementType>): boolean {\n\treturn isSortedBy(iterable, defaultCompare);\n}\n"]}

package/dist/esm/lib/isSortedBy.d.mts

@@ -0,0 +1,32 @@
+import { IterableResolvable } from './from.mjs';
+import { CompareByComparator } from './shared/_compare.mjs';
+
+/**
+ * Checks if the elements of this iterator are sorted using the given comparator function.
+ *
+ * @seealso {@link isSorted} for a version that uses the default comparator.
+ * @seealso {@link isSortedByKey} for a version that allows custom key extractors.
+ *
+ * @param iterable The iterator to compare.
+ *
+ * @example
+ * ```typescript
+ * import { ascNumber, isSortedBy } from '@sapphire/iterator-utilities';
+ *
+ * assert(isSortedBy([1, 2, 2, 9], ascNumber));
+ * assert(!isSortedBy([1, 2, 2, 9], ascNumber));
+ *
+ * assert(isSortedBy([0], () => true));
+ * assert(isSortedBy([0], () => false));
+ *
+ * assert(isSortedBy([], () => true));
+ * assert(isSortedBy([], () => false));
+ * ```
+ *
+ * @remarks
+ *
+ * This function consumes the entire iterator.
+ */
+declare function isSortedBy<const ElementType>(iterable: IterableResolvable<ElementType>, comparator: CompareByComparator<ElementType>): boolean;
+
+export { isSortedBy };

package/dist/esm/lib/isSortedBy.mjs

@@ -0,0 +1,23 @@
+import { __name } from '../chunk-PAWJFY3S.mjs';
+import { assertFunction } from './shared/_assertFunction.mjs';
+import { compareIteratorElements, orderingIsGreater } from './shared/_compare.mjs';
+import { toIterableIterator } from './toIterableIterator.mjs';
+
+function isSortedBy(iterable, comparator) {
+  comparator = assertFunction(comparator);
+  const iterator = toIterableIterator(iterable);
+  const result = iterator.next();
+  if (result.done) return true;
+  let previous = result.value;
+  for (const current of iterator) {
+    const comparison = compareIteratorElements(previous, current, comparator);
+    if (orderingIsGreater(comparison)) return false;
+    previous = current;
+  }
+  return true;
+}
+__name(isSortedBy, "isSortedBy");
+
+export { isSortedBy };
+//# sourceMappingURL=isSortedBy.mjs.map
+//# sourceMappingURL=isSortedBy.mjs.map

package/dist/esm/lib/isSortedBy.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/lib/isSortedBy.ts"],"names":[],"mappings":";;;;;AAiCO,SAAS,UAAA,CAA8B,UAA2C,UAAuD,EAAA;AAC/I,EAAA,UAAA,GAAa,eAAe,UAAU,CAAA,CAAA;AAEtC,EAAM,MAAA,QAAA,GAAW,mBAAmB,QAAQ,CAAA,CAAA;AAC5C,EAAM,MAAA,MAAA,GAAS,SAAS,IAAK,EAAA,CAAA;AAC7B,EAAI,IAAA,MAAA,CAAO,MAAa,OAAA,IAAA,CAAA;AAExB,EAAA,IAAI,WAAW,MAAO,CAAA,KAAA,CAAA;AACtB,EAAA,KAAA,MAAW,WAAW,QAAU,EAAA;AAC/B,IAAA,MAAM,UAAa,GAAA,uBAAA,CAAqC,QAAU,EAAA,OAAA,EAAS,UAAU,CAAA,CAAA;AACrF,IAAI,IAAA,iBAAA,CAAkB,UAAU,CAAA,EAAU,OAAA,KAAA,CAAA;AAE1C,IAAW,QAAA,GAAA,OAAA,CAAA;AAAA,GACZ;AAEA,EAAO,OAAA,IAAA,CAAA;AACR,CAAA;AAhBgB,MAAA,CAAA,UAAA,EAAA,YAAA,CAAA","file":"isSortedBy.mjs","sourcesContent":["import type { IterableResolvable } from './from';\nimport type { isSorted } from './isSorted';\nimport type { isSortedByKey } from './isSortedByKey';\nimport { assertFunction } from './shared/_assertFunction';\nimport { compareIteratorElements, orderingIsGreater, type CompareByComparator } from './shared/_compare';\nimport { toIterableIterator } from './toIterableIterator';\n\n/**\n * Checks if the elements of this iterator are sorted using the given comparator function.\n *\n * @seealso {@link isSorted} for a version that uses the default comparator.\n * @seealso {@link isSortedByKey} for a version that allows custom key extractors.\n *\n * @param iterable The iterator to compare.\n *\n * @example\n * ```typescript\n * import { ascNumber, isSortedBy } from '@sapphire/iterator-utilities';\n *\n * assert(isSortedBy([1, 2, 2, 9], ascNumber));\n * assert(!isSortedBy([1, 2, 2, 9], ascNumber));\n *\n * assert(isSortedBy([0], () => true));\n * assert(isSortedBy([0], () => false));\n *\n * assert(isSortedBy([], () => true));\n * assert(isSortedBy([], () => false));\n * ```\n *\n * @remarks\n *\n * This function consumes the entire iterator.\n */\nexport function isSortedBy<const ElementType>(iterable: IterableResolvable<ElementType>, comparator: CompareByComparator<ElementType>): boolean {\n\tcomparator = assertFunction(comparator);\n\n\tconst iterator = toIterableIterator(iterable);\n\tconst result = iterator.next();\n\tif (result.done) return true;\n\n\tlet previous = result.value;\n\tfor (const current of iterator) {\n\t\tconst comparison = compareIteratorElements<ElementType>(previous, current, comparator);\n\t\tif (orderingIsGreater(comparison)) return false;\n\n\t\tprevious = current;\n\t}\n\n\treturn true;\n}\n"]}

package/dist/esm/lib/isSortedByKey.d.mts

@@ -0,0 +1,30 @@
+import { IterableResolvable } from './from.mjs';
+import { CompareByComparator } from './shared/_compare.mjs';
+
+/**
+ * Checks if the elements of this iterator are sorted using the given key extraction function.
+ *
+ * Instead of comparing the iterator's elements directly, this function compares the keys of the elements, as determined
+ * by `callbackFn`. Apart from that, it's equivalent to {@link isSorted}; see its documentation for more information.
+ *
+ * @seealso {@link isSorted} for a version that uses the default comparator.
+ * @seealso {@link isSortedBy} for a version that allows custom comparators.
+ *
+ * @param iterable The iterator to compare.
+ * @param callbackFn The function to extract the key from an element.
+ *
+ * @example
+ * ```typescript
+ * import { isSortedByKey } from '@sapphire/iterator-utilities';
+ *
+ * assert(isSortedByKey(['c', 'bb', 'aaa'], (s) => s.length));
+ * assert(!isSortedBy([-2, -1, 0, 3], (n) => Math.abs(n)));
+ * ```
+ *
+ * @remarks
+ *
+ * This function consumes the entire iterator.
+ */
+declare function isSortedByKey<const ElementType, const MappedType>(iterable: IterableResolvable<ElementType>, callbackFn: (a: ElementType, index: number) => MappedType, comparator?: CompareByComparator<MappedType>): boolean;
+
+export { isSortedByKey };

package/dist/esm/lib/isSortedByKey.mjs

@@ -0,0 +1,26 @@
+import { __name } from '../chunk-PAWJFY3S.mjs';
+import { assertFunction } from './shared/_assertFunction.mjs';
+import { compareIteratorElements, orderingIsGreater } from './shared/_compare.mjs';
+import { defaultCompare } from './shared/comparators.mjs';
+import { toIterableIterator } from './toIterableIterator.mjs';
+
+function isSortedByKey(iterable, callbackFn, comparator = defaultCompare) {
+  callbackFn = assertFunction(callbackFn);
+  const iterator = toIterableIterator(iterable);
+  const result = iterator.next();
+  if (result.done) return true;
+  let previousKey = callbackFn(result.value, 0);
+  let index = 1;
+  for (const current of iterator) {
+    const currentKey = callbackFn(current, index++);
+    const comparison = compareIteratorElements(previousKey, currentKey, comparator);
+    if (orderingIsGreater(comparison)) return false;
+    previousKey = currentKey;
+  }
+  return true;
+}
+__name(isSortedByKey, "isSortedByKey");
+
+export { isSortedByKey };
+//# sourceMappingURL=isSortedByKey.mjs.map
+//# sourceMappingURL=isSortedByKey.mjs.map

package/dist/esm/lib/isSortedByKey.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/lib/isSortedByKey.ts"],"names":[],"mappings":";;;;;;AAgCO,SAAS,aACf,CAAA,QAAA,EACA,UACA,EAAA,UAAA,GAA8C,cACpC,EAAA;AACV,EAAA,UAAA,GAAa,eAAe,UAAU,CAAA,CAAA;AAEtC,EAAM,MAAA,QAAA,GAAW,mBAAmB,QAAQ,CAAA,CAAA;AAC5C,EAAM,MAAA,MAAA,GAAS,SAAS,IAAK,EAAA,CAAA;AAC7B,EAAI,IAAA,MAAA,CAAO,MAAa,OAAA,IAAA,CAAA;AAExB,EAAA,IAAI,WAAc,GAAA,UAAA,CAAW,MAAO,CAAA,KAAA,EAAO,CAAC,CAAA,CAAA;AAC5C,EAAA,IAAI,KAAQ,GAAA,CAAA,CAAA;AACZ,EAAA,KAAA,MAAW,WAAW,QAAU,EAAA;AAC/B,IAAM,MAAA,UAAA,GAAa,UAAW,CAAA,OAAA,EAAS,KAAO,EAAA,CAAA,CAAA;AAC9C,IAAA,MAAM,UAAa,GAAA,uBAAA,CAAoC,WAAa,EAAA,UAAA,EAAY,UAAU,CAAA,CAAA;AAC1F,IAAI,IAAA,iBAAA,CAAkB,UAAU,CAAA,EAAU,OAAA,KAAA,CAAA;AAE1C,IAAc,WAAA,GAAA,UAAA,CAAA;AAAA,GACf;AAEA,EAAO,OAAA,IAAA,CAAA;AACR,CAAA;AAtBgB,MAAA,CAAA,aAAA,EAAA,eAAA,CAAA","file":"isSortedByKey.mjs","sourcesContent":["import type { IterableResolvable } from './from';\nimport type { isSorted } from './isSorted';\nimport type { isSortedBy } from './isSortedBy';\nimport { assertFunction } from './shared/_assertFunction';\nimport { compareIteratorElements, orderingIsGreater, type CompareByComparator } from './shared/_compare';\nimport { defaultCompare } from './shared/comparators';\nimport { toIterableIterator } from './toIterableIterator';\n\n/**\n * Checks if the elements of this iterator are sorted using the given key extraction function.\n *\n * Instead of comparing the iterator's elements directly, this function compares the keys of the elements, as determined\n * by `callbackFn`. Apart from that, it's equivalent to {@link isSorted}; see its documentation for more information.\n *\n * @seealso {@link isSorted} for a version that uses the default comparator.\n * @seealso {@link isSortedBy} for a version that allows custom comparators.\n *\n * @param iterable The iterator to compare.\n * @param callbackFn The function to extract the key from an element.\n *\n * @example\n * ```typescript\n * import { isSortedByKey } from '@sapphire/iterator-utilities';\n *\n * assert(isSortedByKey(['c', 'bb', 'aaa'], (s) => s.length));\n * assert(!isSortedBy([-2, -1, 0, 3], (n) => Math.abs(n)));\n * ```\n *\n * @remarks\n *\n * This function consumes the entire iterator.\n */\nexport function isSortedByKey<const ElementType, const MappedType>(\n\titerable: IterableResolvable<ElementType>,\n\tcallbackFn: (a: ElementType, index: number) => MappedType,\n\tcomparator: CompareByComparator<MappedType> = defaultCompare\n): boolean {\n\tcallbackFn = assertFunction(callbackFn);\n\n\tconst iterator = toIterableIterator(iterable);\n\tconst result = iterator.next();\n\tif (result.done) return true;\n\n\tlet previousKey = callbackFn(result.value, 0);\n\tlet index = 1;\n\tfor (const current of iterator) {\n\t\tconst currentKey = callbackFn(current, index++);\n\t\tconst comparison = compareIteratorElements<MappedType>(previousKey, currentKey, comparator);\n\t\tif (orderingIsGreater(comparison)) return false;\n\n\t\tpreviousKey = currentKey;\n\t}\n\n\treturn true;\n}\n"]}

package/dist/esm/lib/lessOrEqualThan.d.mts

@@ -0,0 +1,32 @@
+import { IterableResolvable } from './from.mjs';
+
+/**
+ * Determines if the elements of `iterable` are {@link LexicographicComparison lexicographically} less or equal than
+ * those of another.
+ *
+ * @param iterable The iterator to compare.
+ * @param other The iterator to compare against.
+ *
+ * @example
+ * ```typescript
+ * import { lessOrEqualThan } from '@sapphire/iterator-utilities';
+ *
+ * const x = [1, 2, 3, 4];
+ * const y = [1, 4, 9, 16];
+ * console.log(lessOrEqualThan([1], [1]));
+ * // Output: false
+ * console.log(lessOrEqualThan([1], [1, 2]));
+ * // Output: true
+ * console.log(lessOrEqualThan([1, 2], [1]));
+ * // Output: false
+ * console.log(lessOrEqualThan([1, 2], [1, 2]));
+ * // Output: true
+ * ```
+ *
+ * @remarks
+ *
+ * This function consumes the entire iterator.
+ */
+declare function lessOrEqualThan<const ElementType>(iterable: IterableResolvable<ElementType>, other: IterableResolvable<ElementType>): boolean;
+
+export { lessOrEqualThan as le, lessOrEqualThan };

package/dist/esm/lib/lessOrEqualThan.mjs

@@ -0,0 +1,13 @@
+import { __name } from '../chunk-PAWJFY3S.mjs';
+import { compare } from './compare.mjs';
+import { orderingIsGreater } from './shared/_compare.mjs';
+
+function lessOrEqualThan(iterable, other) {
+  const result = compare(iterable, other);
+  return !orderingIsGreater(result);
+}
+__name(lessOrEqualThan, "lessOrEqualThan");
+
+export { lessOrEqualThan as le, lessOrEqualThan };
+//# sourceMappingURL=lessOrEqualThan.mjs.map
+//# sourceMappingURL=lessOrEqualThan.mjs.map

package/dist/esm/lib/lessOrEqualThan.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/lib/lessOrEqualThan.ts"],"names":[],"mappings":";;;;AA+BO,SAAS,eAAA,CAAmC,UAA2C,KAAiD,EAAA;AAC9I,EAAM,MAAA,MAAA,GAAS,OAAQ,CAAA,QAAA,EAAU,KAAK,CAAA,CAAA;AACtC,EAAO,OAAA,CAAC,kBAAkB,MAAM,CAAA,CAAA;AACjC,CAAA;AAHgB,MAAA,CAAA,eAAA,EAAA,iBAAA,CAAA","file":"lessOrEqualThan.mjs","sourcesContent":["import { compare } from './compare';\nimport type { IterableResolvable } from './from';\nimport { orderingIsGreater, type LexicographicComparison } from './shared/_compare';\n\n/**\n * Determines if the elements of `iterable` are {@link LexicographicComparison lexicographically} less or equal than\n * those of another.\n *\n * @param iterable The iterator to compare.\n * @param other The iterator to compare against.\n *\n * @example\n * ```typescript\n * import { lessOrEqualThan } from '@sapphire/iterator-utilities';\n *\n * const x = [1, 2, 3, 4];\n * const y = [1, 4, 9, 16];\n * console.log(lessOrEqualThan([1], [1]));\n * // Output: false\n * console.log(lessOrEqualThan([1], [1, 2]));\n * // Output: true\n * console.log(lessOrEqualThan([1, 2], [1]));\n * // Output: false\n * console.log(lessOrEqualThan([1, 2], [1, 2]));\n * // Output: true\n * ```\n *\n * @remarks\n *\n * This function consumes the entire iterator.\n */\nexport function lessOrEqualThan<const ElementType>(iterable: IterableResolvable<ElementType>, other: IterableResolvable<ElementType>): boolean {\n\tconst result = compare(iterable, other);\n\treturn !orderingIsGreater(result);\n}\n\nexport { lessOrEqualThan as le };\n"]}

package/dist/esm/lib/lessThan.d.mts

@@ -0,0 +1,32 @@
+import { IterableResolvable } from './from.mjs';
+
+/**
+ * Determines if the elements of `iterable` are {@link LexicographicComparison lexicographically} less than those of
+ * another.
+ *
+ * @param iterable The iterator to compare.
+ * @param other The iterator to compare against.
+ *
+ * @example
+ * ```typescript
+ * import { lessThan } from '@sapphire/iterator-utilities';
+ *
+ * const x = [1, 2, 3, 4];
+ * const y = [1, 4, 9, 16];
+ * console.log(lessThan([1], [1]));
+ * // Output: false
+ * console.log(lessThan([1], [1, 2]));
+ * // Output: true
+ * console.log(lessThan([1, 2], [1]));
+ * // Output: false
+ * console.log(lessThan([1, 2], [1, 2]));
+ * // Output: false
+ * ```
+ *
+ * @remarks
+ *
+ * This function consumes the entire iterator.
+ */
+declare function lessThan<const ElementType>(iterable: IterableResolvable<ElementType>, other: IterableResolvable<ElementType>): boolean;
+
+export { lessThan, lessThan as lt };

package/dist/esm/lib/lessThan.mjs

@@ -0,0 +1,13 @@
+import { __name } from '../chunk-PAWJFY3S.mjs';
+import { compare } from './compare.mjs';
+import { orderingIsLess } from './shared/_compare.mjs';
+
+function lessThan(iterable, other) {
+  const result = compare(iterable, other);
+  return orderingIsLess(result);
+}
+__name(lessThan, "lessThan");
+
+export { lessThan, lessThan as lt };
+//# sourceMappingURL=lessThan.mjs.map
+//# sourceMappingURL=lessThan.mjs.map

package/dist/esm/lib/lessThan.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/lib/lessThan.ts"],"names":[],"mappings":";;;;AA+BO,SAAS,QAAA,CAA4B,UAA2C,KAAiD,EAAA;AACvI,EAAM,MAAA,MAAA,GAAS,OAAQ,CAAA,QAAA,EAAU,KAAK,CAAA,CAAA;AACtC,EAAA,OAAO,eAAe,MAAM,CAAA,CAAA;AAC7B,CAAA;AAHgB,MAAA,CAAA,QAAA,EAAA,UAAA,CAAA","file":"lessThan.mjs","sourcesContent":["import { compare } from './compare';\nimport type { IterableResolvable } from './from';\nimport { orderingIsLess, type LexicographicComparison } from './shared/_compare';\n\n/**\n * Determines if the elements of `iterable` are {@link LexicographicComparison lexicographically} less than those of\n * another.\n *\n * @param iterable The iterator to compare.\n * @param other The iterator to compare against.\n *\n * @example\n * ```typescript\n * import { lessThan } from '@sapphire/iterator-utilities';\n *\n * const x = [1, 2, 3, 4];\n * const y = [1, 4, 9, 16];\n * console.log(lessThan([1], [1]));\n * // Output: false\n * console.log(lessThan([1], [1, 2]));\n * // Output: true\n * console.log(lessThan([1, 2], [1]));\n * // Output: false\n * console.log(lessThan([1, 2], [1, 2]));\n * // Output: false\n * ```\n *\n * @remarks\n *\n * This function consumes the entire iterator.\n */\nexport function lessThan<const ElementType>(iterable: IterableResolvable<ElementType>, other: IterableResolvable<ElementType>): boolean {\n\tconst result = compare(iterable, other);\n\treturn orderingIsLess(result);\n}\n\nexport { lessThan as lt };\n"]}

package/dist/esm/lib/max.d.mts

@@ -1,8 +1,13 @@
 import { IterableResolvable } from './from.mjs';
-import { NumberResolvable } from './shared/_toNumberOrThrow.mjs';
 
 /**
- * Consumes the iterable and returns the highest number element. If the iterable is empty, or contains only non-number values, it returns `null`.
+ * Consumes the iterable and returns the highest number element. If the iterable is empty, it returns `null`.
+ *
+ * This function uses the default comparator (lexicographically), which means it will compare the elements as strings.
+ * If this is undesirable, use {@link maxBy} instead.
+ *
+ * @seealso {@link maxBy} for a version that allows custom comparators.
+ * @seealso {@link maxByKey} for a version that allows custom key extractors.
  *
  * @param iterable An iterator of number values to determine the maximum value of.
  * @returns The maximum value in the input iterator, or `null` if the iterator is empty or contains only non-number values.
@@ -20,6 +25,6 @@ import { NumberResolvable } from './shared/_toNumberOrThrow.mjs';
  *
  * This function consumes the entire iterator.
  */
-declare function max(iterable: IterableResolvable<NumberResolvable>): number | null;
+declare function max<const ElementType>(iterable: IterableResolvable<ElementType>): ElementType | null;
 
 export { max };

package/dist/esm/lib/max.mjs

@@ -1,13 +1,9 @@
 import { __name } from '../chunk-PAWJFY3S.mjs';
-import { map } from './map.mjs';
-import { toNumberOrThrow } from './shared/_toNumberOrThrow.mjs';
+import { maxBy } from './maxBy.mjs';
+import { defaultCompare } from './shared/comparators.mjs';
 
 function max(iterable) {
-  let max2 = null;
-  for (const value of map(iterable, toNumberOrThrow)) {
-    if (max2 === null || value > max2) max2 = value;
-  }
-  return max2;
+  return maxBy(iterable, defaultCompare);
 }
 __name(max, "max");
 

package/dist/esm/lib/max.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/lib/max.ts"],"names":["max"],"mappings":";;;;AAuBO,SAAS,IAAI,QAA+D,EAAA;AAClF,EAAA,IAAIA,IAAqB,GAAA,IAAA,CAAA;AACzB,EAAA,KAAA,MAAW,KAAS,IAAA,GAAA,CAAI,QAAU,EAAA,eAAe,CAAG,EAAA;AACnD,IAAA,IAAIA,IAAQ,KAAA,IAAA,IAAQ,KAAQA,GAAAA,IAAAA,EAAKA,IAAM,GAAA,KAAA,CAAA;AAAA,GACxC;AAEA,EAAOA,OAAAA,IAAAA,CAAAA;AACR,CAAA;AAPgB,MAAA,CAAA,GAAA,EAAA,KAAA,CAAA","file":"max.mjs","sourcesContent":["import type { IterableResolvable } from './from';\nimport { map } from './map';\nimport { toNumberOrThrow, type NumberResolvable } from './shared/_toNumberOrThrow';\n\n/**\n * Consumes the iterable and returns the highest number element. If the iterable is empty, or contains only non-number values, it returns `null`.\n *\n * @param iterable An iterator of number values to determine the maximum value of.\n * @returns The maximum value in the input iterator, or `null` if the iterator is empty or contains only non-number values.\n *\n * @example\n * ```typescript\n * import { max } from '@sapphire/iterator-utilities';\n *\n * const iterable = [1, 2, 3, 4, 5];\n * console.log(max(iterable));\n * // Output: 5\n * ```\n *\n * @remarks\n *\n * This function consumes the entire iterator.\n */\nexport function max(iterable: IterableResolvable<NumberResolvable>): number | null {\n\tlet max: number | null = null;\n\tfor (const value of map(iterable, toNumberOrThrow)) {\n\t\tif (max === null || value > max) max = value;\n\t}\n\n\treturn max;\n}\n"]}
+{"version":3,"sources":["../../../src/lib/max.ts"],"names":[],"mappings":";;;;AA8BO,SAAS,IAAuB,QAA+D,EAAA;AACrG,EAAO,OAAA,KAAA,CAAM,UAAU,cAAc,CAAA,CAAA;AACtC,CAAA;AAFgB,MAAA,CAAA,GAAA,EAAA,KAAA,CAAA","file":"max.mjs","sourcesContent":["import type { IterableResolvable } from './from';\nimport { maxBy } from './maxBy';\nimport type { maxByKey } from './maxByKey';\nimport { defaultCompare } from './shared/comparators';\n\n/**\n * Consumes the iterable and returns the highest number element. If the iterable is empty, it returns `null`.\n *\n * This function uses the default comparator (lexicographically), which means it will compare the elements as strings.\n * If this is undesirable, use {@link maxBy} instead.\n *\n * @seealso {@link maxBy} for a version that allows custom comparators.\n * @seealso {@link maxByKey} for a version that allows custom key extractors.\n *\n * @param iterable An iterator of number values to determine the maximum value of.\n * @returns The maximum value in the input iterator, or `null` if the iterator is empty or contains only non-number values.\n *\n * @example\n * ```typescript\n * import { max } from '@sapphire/iterator-utilities';\n *\n * const iterable = [1, 2, 3, 4, 5];\n * console.log(max(iterable));\n * // Output: 5\n * ```\n *\n * @remarks\n *\n * This function consumes the entire iterator.\n */\nexport function max<const ElementType>(iterable: IterableResolvable<ElementType>): ElementType | null {\n\treturn maxBy(iterable, defaultCompare);\n}\n"]}

package/dist/esm/lib/maxBy.d.mts

@@ -0,0 +1,31 @@
+import { IterableResolvable } from './from.mjs';
+import { CompareByComparator } from './shared/_compare.mjs';
+
+/**
+ * Returns the element that gives the maximum value with respect to the specified comparison function.
+ *
+ * If several elements are equally maximum, the last element is returned. If the iterator is empty, `null` is returned.
+ *
+ * @seealso {@link max} for a version that uses the default comparator.
+ * @seealso {@link maxByKey} for a version that allows custom key extractors.
+ *
+ * @param iterable An iterator of number values to determine the maximum value of.
+ * @param comparator A function to execute for each element produced by the iterator. It should return a number value.
+ * @returns The element that gives the maximum value from the specified function, or `null` if the iterator is empty.
+ *
+ * @example
+ * ```typescript
+ * import { ascNumber, maxBy } from '@sapphire/iterator-utilities';
+ *
+ * const iterable = [-3, 0, 1, 5, -10];
+ * console.log(maxBy(iterable, ascNumber));
+ * // Output: 5
+ * ```
+ *
+ * @remarks
+ *
+ * This function consumes the entire iterator.
+ */
+declare function maxBy<const ElementType>(iterable: IterableResolvable<ElementType>, comparator: CompareByComparator<ElementType>): ElementType | null;
+
+export { maxBy };