@sapphire/iterator-utilities 1.0.0

package/dist/cjs/lib/reverse.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/lib/reverse.ts"],"names":[],"mappings":";;;;AACA,SAAS,0BAA0B;AAuB5B,UAAU,QAA2B,UAA0E;AACrH,QAAM,QAAuB,CAAC;AAC9B,aAAW,QAAQ,mBAAmB,QAAQ,GAAG;AAChD,UAAM,KAAK,IAAI;AAAA,EAChB;AAEA,WAAS,IAAI,MAAM,SAAS,GAAG,KAAK,GAAG,KAAK;AAC3C,UAAM,MAAM,CAAC;AAAA,EACd;AACD;AATiB","sourcesContent":["import type { IterableResolvable } from './from';\nimport { toIterableIterator } from './toIterableIterator';\n\n/**\n * Consumes the iterable and returns a new iterable with the elements in reverse order.\n *\n * @param iterable The iterator to reverse.\n * @returns An iterator whose element correspond to the elements of the provided iterator in reverse order.\n *\n * @example\n * ```typescript\n * import { reverse } from '@sapphire/iterator-utilities';\n *\n * console.log([...reverse([1, 2, 3, 4, 5])]);\n * // Output: [5, 4, 3, 2, 1]\n *\n * console.log([...reverse('hello')]);\n * // Output: ['o', 'l', 'l', 'e', 'h']\n * ```\n *\n * @remarks\n *\n * This function collects all elements of the provided iterator into an array before yielding them in reverse order.\n */\nexport function* reverse<const ElementType>(iterable: IterableResolvable<ElementType>): IterableIterator<ElementType> {\n\tconst items: ElementType[] = [];\n\tfor (const item of toIterableIterator(iterable)) {\n\t\titems.push(item);\n\t}\n\n\tfor (let i = items.length - 1; i >= 0; i--) {\n\t\tyield items[i];\n\t}\n}\n"]}

package/dist/cjs/lib/reverse.d.cts

@@ -0,0 +1,26 @@
+import { IterableResolvable } from './from.cjs';
+
+/**
+ * Consumes the iterable and returns a new iterable with the elements in reverse order.
+ *
+ * @param iterable The iterator to reverse.
+ * @returns An iterator whose element correspond to the elements of the provided iterator in reverse order.
+ *
+ * @example
+ * ```typescript
+ * import { reverse } from '@sapphire/iterator-utilities';
+ *
+ * console.log([...reverse([1, 2, 3, 4, 5])]);
+ * // Output: [5, 4, 3, 2, 1]
+ *
+ * console.log([...reverse('hello')]);
+ * // Output: ['o', 'l', 'l', 'e', 'h']
+ * ```
+ *
+ * @remarks
+ *
+ * This function collects all elements of the provided iterator into an array before yielding them in reverse order.
+ */
+declare function reverse<const ElementType>(iterable: IterableResolvable<ElementType>): IterableIterator<ElementType>;
+
+export { reverse };

package/dist/cjs/lib/shared/_assertFunction.cjs

@@ -0,0 +1,17 @@
+'use strict';
+
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+
+// src/lib/shared/_assertFunction.ts
+function assertFunction(value) {
+  if (typeof value !== "function") {
+    throw new TypeError(`${value} must be a function`);
+  }
+  return value;
+}
+__name(assertFunction, "assertFunction");
+
+exports.assertFunction = assertFunction;
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=_assertFunction.cjs.map

package/dist/cjs/lib/shared/_assertFunction.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/lib/shared/_assertFunction.ts"],"names":[],"mappings":";;;;AAAO,SAAS,eAAmD,OAAe;AACjF,MAAI,OAAO,UAAU,YAAY;AAChC,UAAM,IAAI,UAAU,GAAG,KAAK,qBAAqB;AAAA,EAClD;AAEA,SAAO;AACR;AANgB","sourcesContent":["export function assertFunction<Fn extends (...args: any[]) => any>(value: Fn): Fn {\n\tif (typeof value !== 'function') {\n\t\tthrow new TypeError(`${value} must be a function`);\n\t}\n\n\treturn value;\n}\n"]}

package/dist/cjs/lib/shared/_assertFunction.d.cts

@@ -0,0 +1,3 @@
+declare function assertFunction<Fn extends (...args: any[]) => any>(value: Fn): Fn;
+
+export { assertFunction };

package/dist/cjs/lib/shared/_assertNotNegative.cjs

@@ -0,0 +1,17 @@
+'use strict';
+
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+
+// src/lib/shared/_assertNotNegative.ts
+function assertNotNegative(value, original) {
+  if (value < 0) {
+    throw new RangeError(`${original} must be a non-negative number`);
+  }
+  return value;
+}
+__name(assertNotNegative, "assertNotNegative");
+
+exports.assertNotNegative = assertNotNegative;
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=_assertNotNegative.cjs.map

package/dist/cjs/lib/shared/_assertNotNegative.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/lib/shared/_assertNotNegative.ts"],"names":[],"mappings":";;;;AAAO,SAAS,kBAAkB,OAAe,UAA2B;AAC3E,MAAI,QAAQ,GAAG;AACd,UAAM,IAAI,WAAW,GAAG,QAAQ,gCAAgC;AAAA,EACjE;AAEA,SAAO;AACR;AANgB","sourcesContent":["export function assertNotNegative(value: number, original: unknown): number {\n\tif (value < 0) {\n\t\tthrow new RangeError(`${original} must be a non-negative number`);\n\t}\n\n\treturn value;\n}\n"]}

package/dist/cjs/lib/shared/_assertNotNegative.d.cts

@@ -0,0 +1,3 @@
+declare function assertNotNegative(value: number, original: unknown): number;
+
+export { assertNotNegative };

package/dist/cjs/lib/shared/_assertPositive.cjs

@@ -0,0 +1,17 @@
+'use strict';
+
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+
+// src/lib/shared/_assertPositive.ts
+function assertPositive(value, original) {
+  if (value <= 0) {
+    throw new RangeError(`${original} must be a positive number`);
+  }
+  return value;
+}
+__name(assertPositive, "assertPositive");
+
+exports.assertPositive = assertPositive;
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=_assertPositive.cjs.map

package/dist/cjs/lib/shared/_assertPositive.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/lib/shared/_assertPositive.ts"],"names":[],"mappings":";;;;AAAO,SAAS,eAAe,OAAe,UAA2B;AACxE,MAAI,SAAS,GAAG;AACf,UAAM,IAAI,WAAW,GAAG,QAAQ,4BAA4B;AAAA,EAC7D;AAEA,SAAO;AACR;AANgB","sourcesContent":["export function assertPositive(value: number, original: unknown): number {\n\tif (value <= 0) {\n\t\tthrow new RangeError(`${original} must be a positive number`);\n\t}\n\n\treturn value;\n}\n"]}

package/dist/cjs/lib/shared/_assertPositive.d.cts

@@ -0,0 +1,3 @@
+declare function assertPositive(value: number, original: unknown): number;
+
+export { assertPositive };

package/dist/cjs/lib/shared/_makeIterableIterator.cjs

@@ -0,0 +1,19 @@
+'use strict';
+
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+
+// src/lib/shared/_makeIterableIterator.ts
+function makeIterableIterator(next) {
+  return {
+    next,
+    [Symbol.iterator]() {
+      return this;
+    }
+  };
+}
+__name(makeIterableIterator, "makeIterableIterator");
+
+exports.makeIterableIterator = makeIterableIterator;
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=_makeIterableIterator.cjs.map

package/dist/cjs/lib/shared/_makeIterableIterator.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/lib/shared/_makeIterableIterator.ts"],"names":[],"mappings":";;;;AAAO,SAAS,qBAAwC,MAAoE;AAC3H,SAAO;AAAA,IACN;AAAA,IACA,CAAC,OAAO,QAAQ,IAAI;AACnB,aAAO;AAAA,IACR;AAAA,EACD;AACD;AAPgB","sourcesContent":["export function makeIterableIterator<const ElementType>(next: Iterator<ElementType>['next']): IterableIterator<ElementType> {\n\treturn {\n\t\tnext,\n\t\t[Symbol.iterator]() {\n\t\t\treturn this;\n\t\t}\n\t};\n}\n"]}

package/dist/cjs/lib/shared/_makeIterableIterator.d.cts

@@ -0,0 +1,3 @@
+declare function makeIterableIterator<const ElementType>(next: Iterator<ElementType>['next']): IterableIterator<ElementType>;
+
+export { makeIterableIterator };

package/dist/cjs/lib/shared/_toIntegerOrInfinityOrThrow.cjs

@@ -0,0 +1,21 @@
+'use strict';
+
+var _toNumberOrThrow_cjs = require('./_toNumberOrThrow.cjs');
+
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+function toIntegerOrInfinityOrThrow(value) {
+  const number = _toNumberOrThrow_cjs.toNumberOrThrow(value);
+  if (Number.isNaN(number) || number === 0)
+    return 0;
+  if (number === Number.POSITIVE_INFINITY)
+    return Number.POSITIVE_INFINITY;
+  if (number === Number.NEGATIVE_INFINITY)
+    return Number.NEGATIVE_INFINITY;
+  return Math.trunc(number);
+}
+__name(toIntegerOrInfinityOrThrow, "toIntegerOrInfinityOrThrow");
+
+exports.toIntegerOrInfinityOrThrow = toIntegerOrInfinityOrThrow;
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=_toIntegerOrInfinityOrThrow.cjs.map

package/dist/cjs/lib/shared/_toIntegerOrInfinityOrThrow.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/lib/shared/_toIntegerOrInfinityOrThrow.ts"],"names":[],"mappings":";;;;AAAA,SAAS,uBAAuB;AAEzB,SAAS,2BAA2B,OAAuB;AACjE,QAAM,SAAS,gBAAgB,KAAK;AACpC,MAAI,OAAO,MAAM,MAAM,KAAK,WAAW;AAAG,WAAO;AACjD,MAAI,WAAW,OAAO;AAAmB,WAAO,OAAO;AACvD,MAAI,WAAW,OAAO;AAAmB,WAAO,OAAO;AAEvD,SAAO,KAAK,MAAM,MAAM;AACzB;AAPgB","sourcesContent":["import { toNumberOrThrow } from './_toNumberOrThrow';\n\nexport function toIntegerOrInfinityOrThrow(value: number): number {\n\tconst number = toNumberOrThrow(value);\n\tif (Number.isNaN(number) || number === 0) return 0;\n\tif (number === Number.POSITIVE_INFINITY) return Number.POSITIVE_INFINITY;\n\tif (number === Number.NEGATIVE_INFINITY) return Number.NEGATIVE_INFINITY;\n\n\treturn Math.trunc(number);\n}\n"]}

package/dist/cjs/lib/shared/_toIntegerOrInfinityOrThrow.d.cts

@@ -0,0 +1,3 @@
+declare function toIntegerOrInfinityOrThrow(value: number): number;
+
+export { toIntegerOrInfinityOrThrow };

package/dist/cjs/lib/shared/_toIntegerOrThrow.cjs

@@ -0,0 +1,21 @@
+'use strict';
+
+var _toNumberOrThrow_cjs = require('./_toNumberOrThrow.cjs');
+
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+function toIntegerOrThrow(value) {
+  const number = _toNumberOrThrow_cjs.toNumberOrThrow(value);
+  if (Number.isNaN(number) || number === 0)
+    return 0;
+  if (number === Number.POSITIVE_INFINITY)
+    throw new RangeError("+Infinity cannot be represented as an integer");
+  if (number === Number.NEGATIVE_INFINITY)
+    throw new RangeError("-Infinity cannot be represented as an integer");
+  return Math.trunc(number);
+}
+__name(toIntegerOrThrow, "toIntegerOrThrow");
+
+exports.toIntegerOrThrow = toIntegerOrThrow;
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=_toIntegerOrThrow.cjs.map

package/dist/cjs/lib/shared/_toIntegerOrThrow.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/lib/shared/_toIntegerOrThrow.ts"],"names":[],"mappings":";;;;AAAA,SAAS,uBAAuB;AAEzB,SAAS,iBAAiB,OAAuB;AACvD,QAAM,SAAS,gBAAgB,KAAK;AACpC,MAAI,OAAO,MAAM,MAAM,KAAK,WAAW;AAAG,WAAO;AACjD,MAAI,WAAW,OAAO;AAAmB,UAAM,IAAI,WAAW,+CAA+C;AAC7G,MAAI,WAAW,OAAO;AAAmB,UAAM,IAAI,WAAW,+CAA+C;AAE7G,SAAO,KAAK,MAAM,MAAM;AACzB;AAPgB","sourcesContent":["import { toNumberOrThrow } from './_toNumberOrThrow';\n\nexport function toIntegerOrThrow(value: number): number {\n\tconst number = toNumberOrThrow(value);\n\tif (Number.isNaN(number) || number === 0) return 0;\n\tif (number === Number.POSITIVE_INFINITY) throw new RangeError('+Infinity cannot be represented as an integer');\n\tif (number === Number.NEGATIVE_INFINITY) throw new RangeError('-Infinity cannot be represented as an integer');\n\n\treturn Math.trunc(number);\n}\n"]}

package/dist/cjs/lib/shared/_toIntegerOrThrow.d.cts

@@ -0,0 +1,3 @@
+declare function toIntegerOrThrow(value: number): number;
+
+export { toIntegerOrThrow };

package/dist/cjs/lib/shared/_toNumberOrThrow.cjs

@@ -0,0 +1,34 @@
+'use strict';
+
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+
+// src/lib/shared/_toNumberOrThrow.ts
+function toNumberOrThrow(value) {
+  switch (typeof value) {
+    case "bigint":
+      throw new TypeError("Cannot convert a BigInt value to a number");
+    case "symbol":
+      throw new TypeError("Cannot convert a Symbol value to a number");
+    case "boolean":
+      return value ? 1 : 0;
+    case "number":
+      return assertNumber(value, value);
+    case "undefined":
+      throw new TypeError("Cannot convert an undefined value to a number");
+    default:
+      return assertNumber(Number(value), value);
+  }
+}
+__name(toNumberOrThrow, "toNumberOrThrow");
+function assertNumber(value, original) {
+  if (Number.isNaN(value)) {
+    throw new RangeError(`${original} must be a non-NaN number`);
+  }
+  return value;
+}
+__name(assertNumber, "assertNumber");
+
+exports.toNumberOrThrow = toNumberOrThrow;
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=_toNumberOrThrow.cjs.map

package/dist/cjs/lib/shared/_toNumberOrThrow.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/lib/shared/_toNumberOrThrow.ts"],"names":[],"mappings":";;;;AAAO,SAAS,gBAAgB,OAAiC;AAChE,UAAQ,OAAO,OAAO;AAAA,IACrB,KAAK;AACJ,YAAM,IAAI,UAAU,2CAA2C;AAAA,IAChE,KAAK;AACJ,YAAM,IAAI,UAAU,2CAA2C;AAAA,IAChE,KAAK;AACJ,aAAO,QAAQ,IAAI;AAAA,IACpB,KAAK;AACJ,aAAO,aAAa,OAAO,KAAK;AAAA,IACjC,KAAK;AACJ,YAAM,IAAI,UAAU,+CAA+C;AAAA,IACpE;AACC,aAAO,aAAa,OAAO,KAAK,GAAG,KAAK;AAAA,EAC1C;AACD;AAfgB;AAmBhB,SAAS,aAAa,OAAe,UAA2B;AAC/D,MAAI,OAAO,MAAM,KAAK,GAAG;AACxB,UAAM,IAAI,WAAW,GAAG,QAAQ,2BAA2B;AAAA,EAC5D;AAEA,SAAO;AACR;AANS","sourcesContent":["export function toNumberOrThrow(value: NumberResolvable): number {\n\tswitch (typeof value) {\n\t\tcase 'bigint':\n\t\t\tthrow new TypeError('Cannot convert a BigInt value to a number');\n\t\tcase 'symbol':\n\t\t\tthrow new TypeError('Cannot convert a Symbol value to a number');\n\t\tcase 'boolean':\n\t\t\treturn value ? 1 : 0;\n\t\tcase 'number':\n\t\t\treturn assertNumber(value, value);\n\t\tcase 'undefined':\n\t\t\tthrow new TypeError('Cannot convert an undefined value to a number');\n\t\tdefault:\n\t\t\treturn assertNumber(Number(value), value);\n\t}\n}\n\nexport type NumberResolvable = number | boolean | null | { valueOf(): number | boolean | null } | { [Symbol.toPrimitive](): number | boolean | null };\n\nfunction assertNumber(value: number, original: unknown): number {\n\tif (Number.isNaN(value)) {\n\t\tthrow new RangeError(`${original} must be a non-NaN number`);\n\t}\n\n\treturn value;\n}\n"]}

package/dist/cjs/lib/shared/_toNumberOrThrow.d.cts

@@ -0,0 +1,8 @@
+declare function toNumberOrThrow(value: NumberResolvable): number;
+type NumberResolvable = number | boolean | null | {
+    valueOf(): number | boolean | null;
+} | {
+    [Symbol.toPrimitive](): number | boolean | null;
+};
+
+export { type NumberResolvable, toNumberOrThrow };

package/dist/cjs/lib/slice.cjs

@@ -0,0 +1,44 @@
+'use strict';
+
+var drop_cjs = require('./drop.cjs');
+var dropLast_cjs = require('./dropLast.cjs');
+var empty_cjs = require('./empty.cjs');
+var _toIntegerOrInfinityOrThrow_cjs = require('./shared/_toIntegerOrInfinityOrThrow.cjs');
+var take_cjs = require('./take.cjs');
+var takeLast_cjs = require('./takeLast.cjs');
+
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+function slice(iterable, start, end) {
+  start = _toIntegerOrInfinityOrThrow_cjs.toIntegerOrInfinityOrThrow(start ?? 0);
+  if (start === Number.NEGATIVE_INFINITY) {
+    start = 0;
+  }
+  if (end === void 0) {
+    return start >= 0 ? drop_cjs.drop(iterable, start) : takeLast_cjs.takeLast(iterable, -start);
+  }
+  end = _toIntegerOrInfinityOrThrow_cjs.toIntegerOrInfinityOrThrow(end);
+  if (end < 0) {
+    if (end === Number.NEGATIVE_INFINITY) {
+      return empty_cjs.empty();
+    }
+    if (start === 0) {
+      return dropLast_cjs.dropLast(iterable, -end);
+    }
+    if (start >= 0) {
+      return dropLast_cjs.dropLast(drop_cjs.drop(iterable, start), -end);
+    }
+    if (start >= end) {
+      return empty_cjs.empty();
+    }
+    return take_cjs.take(takeLast_cjs.takeLast(iterable, -start), end - start);
+  }
+  if (start >= end)
+    return empty_cjs.empty();
+  return end === Number.POSITIVE_INFINITY ? drop_cjs.drop(iterable, start) : take_cjs.take(drop_cjs.drop(iterable, start), end - start);
+}
+__name(slice, "slice");
+
+exports.slice = slice;
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=slice.cjs.map

package/dist/cjs/lib/slice.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/lib/slice.ts"],"names":[],"mappings":";;;;AAAA,SAAS,YAAY;AACrB,SAAS,gBAAgB;AACzB,SAAS,aAAa;AAEtB,SAAS,kCAAkC;AAC3C,SAAS,YAAY;AACrB,SAAS,gBAAgB;AA2DlB,SAAS,MAAyB,UAA2C,OAAgB,KAA6C;AAEhJ,UAAQ,2BAA2B,SAAS,CAAC;AAC7C,MAAI,UAAU,OAAO,mBAAmB;AACvC,YAAQ;AAAA,EACT;AAIA,MAAI,QAAQ,QAAW;AACtB,WAAO,SAAS,IACb,KAAK,UAAU,KAAK,IACpB,SAAS,UAAU,CAAC,KAAK;AAAA,EAC7B;AAEA,QAAM,2BAA2B,GAAG;AAEpC,MAAI,MAAM,GAAG;AAGZ,QAAI,QAAQ,OAAO,mBAAmB;AACrC,aAAO,MAAM;AAAA,IACd;AAGA,QAAI,UAAU,GAAG;AAChB,aAAO,SAAS,UAAU,CAAC,GAAG;AAAA,IAC/B;AAIA,QAAI,SAAS,GAAG;AACf,aAAO,SAAS,KAAK,UAAU,KAAK,GAAG,CAAC,GAAG;AAAA,IAC5C;AAIA,QAAI,SAAS,KAAK;AACjB,aAAO,MAAM;AAAA,IACd;AAIA,WAAO,KAAK,SAAS,UAAU,CAAC,KAAK,GAAG,MAAM,KAAK;AAAA,EACpD;AAGA,MAAI,SAAS;AAAK,WAAO,MAAM;AAG/B,SAAO,QAAQ,OAAO,oBACnB,KAAK,UAAU,KAAK,IACpB,KAAK,KAAK,UAAU,KAAK,GAAG,MAAM,KAAK;AAC3C;AArDgB","sourcesContent":["import { drop } from './drop';\nimport { dropLast } from './dropLast';\nimport { empty } from './empty';\nimport type { IterableResolvable } from './from';\nimport { toIntegerOrInfinityOrThrow } from './shared/_toIntegerOrInfinityOrThrow';\nimport { take } from './take';\nimport { takeLast } from './takeLast';\n\n/**\n * Produces an iterable with the elements from the `start` index to the `end` index (exclusive).\n *\n * @param iterable The iterator to slice.\n * @param start The index at which to begin extraction.\n * @param end The index at which to end extraction.\n * @returns An iterator that contains the elements of the provided iterator from `start` to `end`.\n *\n * @example\n * ```typescript\n * import { slice } from '@sapphire/iterator-utilities';\n *\n * const iterable = [1, 2, 3, 4, 5];\n * console.log([...slice(, 1, 3)]);\n * // Output: [2, 3]\n * ```\n *\n * @example\n * ```typescript\n * const iterable = [1, 2, 3, 4, 5];\n * console.log([...slice(iterable, -2)]);\n * // Output: [4, 5]\n * ```\n *\n * @example\n * ```typescript\n * const iterable = [1, 2, 3, 4, 5];\n * console.log([...slice(iterable, 2)]);\n * // Output: [3, 4, 5]\n * ```\n *\n * @example\n * ```typescript\n * const iterable = [1, 2, 3, 4, 5];\n * console.log([...slice(iterable, 2, -1)]);\n * // Output: [3, 4]\n * ```\n *\n * @example\n * ```typescript\n * const iterable = [1, 2, 3, 4, 5];\n * console.log([...slice(iterable, -2, -1)]);\n * // Output: [4]\n * ```\n *\n * @example\n * ```typescript\n * const iterable = [1, 2, 3, 4, 5];\n * console.log([...slice(iterable, 2, 1)]);\n * // Output: []\n * ```\n *\n * @remarks\n *\n * This function consumes the input iterator based on the `start` and `end` values, therefore, you should not use the\n * original iterator after calling this function.\n */\nexport function slice<const ElementType>(iterable: IterableResolvable<ElementType>, start?: number, end?: number): IterableIterator<ElementType> {\n\t// https://tc39.es/ecma262/#sec-array.prototype.slice\n\tstart = toIntegerOrInfinityOrThrow(start ?? 0);\n\tif (start === Number.NEGATIVE_INFINITY) {\n\t\tstart = 0;\n\t}\n\n\t// 1. If end is not provided, `slice` behaves like `drop` or `takeLast`,\n\t// depending on the sign of `start`:\n\tif (end === undefined) {\n\t\treturn start >= 0 //\n\t\t\t? drop(iterable, start)\n\t\t\t: takeLast(iterable, -start);\n\t}\n\n\tend = toIntegerOrInfinityOrThrow(end);\n\t// 2. If end is negative:\n\tif (end < 0) {\n\t\t// 2.1. If `end` is `-Infinity`, end would be `0`, which will always\n\t\t// result on an empty iterator:\n\t\tif (end === Number.NEGATIVE_INFINITY) {\n\t\t\treturn empty();\n\t\t}\n\n\t\t// 2.2. If start is positive, drop the last n elements:\n\t\tif (start === 0) {\n\t\t\treturn dropLast(iterable, -end);\n\t\t}\n\n\t\t// 2.3. If the start is positive, drop the first n elements and take the\n\t\t// last m elements:\n\t\tif (start >= 0) {\n\t\t\treturn dropLast(drop(iterable, start), -end);\n\t\t}\n\n\t\t// 2.4. If the start is the same or greater than the end, return an\n\t\t// empty iterator:\n\t\tif (start >= end) {\n\t\t\treturn empty();\n\t\t}\n\n\t\t// 2.5. `start` and `end` are negative, take the elements between the\n\t\t// start and end:\n\t\treturn take(takeLast(iterable, -start), end - start);\n\t}\n\n\t// 3.0. If `start` is greater than or equal to `end`, return an empty iterator:\n\tif (start >= end) return empty();\n\n\t// 4.0. Otherwise, take the elements between `start` and `end`:\n\treturn end === Number.POSITIVE_INFINITY //\n\t\t? drop(iterable, start)\n\t\t: take(drop(iterable, start), end - start);\n}\n"]}

package/dist/cjs/lib/slice.d.cts

@@ -0,0 +1,62 @@
+import { IterableResolvable } from './from.cjs';
+
+/**
+ * Produces an iterable with the elements from the `start` index to the `end` index (exclusive).
+ *
+ * @param iterable The iterator to slice.
+ * @param start The index at which to begin extraction.
+ * @param end The index at which to end extraction.
+ * @returns An iterator that contains the elements of the provided iterator from `start` to `end`.
+ *
+ * @example
+ * ```typescript
+ * import { slice } from '@sapphire/iterator-utilities';
+ *
+ * const iterable = [1, 2, 3, 4, 5];
+ * console.log([...slice(, 1, 3)]);
+ * // Output: [2, 3]
+ * ```
+ *
+ * @example
+ * ```typescript
+ * const iterable = [1, 2, 3, 4, 5];
+ * console.log([...slice(iterable, -2)]);
+ * // Output: [4, 5]
+ * ```
+ *
+ * @example
+ * ```typescript
+ * const iterable = [1, 2, 3, 4, 5];
+ * console.log([...slice(iterable, 2)]);
+ * // Output: [3, 4, 5]
+ * ```
+ *
+ * @example
+ * ```typescript
+ * const iterable = [1, 2, 3, 4, 5];
+ * console.log([...slice(iterable, 2, -1)]);
+ * // Output: [3, 4]
+ * ```
+ *
+ * @example
+ * ```typescript
+ * const iterable = [1, 2, 3, 4, 5];
+ * console.log([...slice(iterable, -2, -1)]);
+ * // Output: [4]
+ * ```
+ *
+ * @example
+ * ```typescript
+ * const iterable = [1, 2, 3, 4, 5];
+ * console.log([...slice(iterable, 2, 1)]);
+ * // Output: []
+ * ```
+ *
+ * @remarks
+ *
+ * This function consumes the input iterator based on the `start` and `end` values, therefore, you should not use the
+ * original iterator after calling this function.
+ */
+declare function slice<const ElementType>(iterable: IterableResolvable<ElementType>, start?: number, end?: number): IterableIterator<ElementType>;
+
+export { slice };

package/dist/cjs/lib/some.cjs

@@ -0,0 +1,22 @@
+'use strict';
+
+var _assertFunction_cjs = require('./shared/_assertFunction.cjs');
+var toIterableIterator_cjs = require('./toIterableIterator.cjs');
+
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+function some(iterable, callbackFn) {
+  callbackFn = _assertFunction_cjs.assertFunction(callbackFn);
+  let index = 0;
+  for (const value of toIterableIterator_cjs.toIterableIterator(iterable)) {
+    if (callbackFn(value, index++)) {
+      return true;
+    }
+  }
+  return false;
+}
+__name(some, "some");
+
+exports.some = some;
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=some.cjs.map

package/dist/cjs/lib/some.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/lib/some.ts"],"names":[],"mappings":";;;;AACA,SAAS,sBAAsB;AAC/B,SAAS,0BAA0B;AA8B5B,SAAS,KACf,UACA,YACU;AACV,eAAa,eAAe,UAAU;AAEtC,MAAI,QAAQ;AACZ,aAAW,SAAS,mBAAmB,QAAQ,GAAG;AACjD,QAAI,WAAW,OAAO,OAAO,GAAG;AAC/B,aAAO;AAAA,IACR;AAAA,EACD;AAEA,SAAO;AACR;AAdgB","sourcesContent":["import type { IterableResolvable } from './from';\nimport { assertFunction } from './shared/_assertFunction';\nimport { toIterableIterator } from './toIterableIterator';\n\n/**\n * Advances the iterable until it finds a matching element, returning `true` if it's found and `false` otherwise.\n *\n * @param iterable An iterator to search for a value in.\n * @param callbackFn A function to execute for each element produced by the iterator. It should return a truthy value to\n * indicate the element passes the test, and a falsy value otherwise.\n * @returns `true` if the callback function returns a truthy value for at least one element. Otherwise, `false`.\n *\n * @example\n * ```typescript\n * import { some } from '@sapphire/iterator-utilities';\n *\n * const iterable = [1, 2, 3, 4, 5];\n * console.log(some(iterable, (value) => value % 2 === 0));\n * // Output: true\n * ```\n *\n * @example\n * ```typescript\n * const iterable = [1, 2, 3, 4, 5];\n * console.log(some(iterable, (value) => value % 6 === 0));\n * // Output: false\n * ```\n *\n * @remarks\n *\n * This function consumes the iterator until the value is found or the iterator is exhausted.\n */\nexport function some<const ElementType>(\n\titerable: IterableResolvable<ElementType>,\n\tcallbackFn: (element: ElementType, index: number) => boolean\n): boolean {\n\tcallbackFn = assertFunction(callbackFn);\n\n\tlet index = 0;\n\tfor (const value of toIterableIterator(iterable)) {\n\t\tif (callbackFn(value, index++)) {\n\t\t\treturn true;\n\t\t}\n\t}\n\n\treturn false;\n}\n"]}

package/dist/cjs/lib/some.d.cts

@@ -0,0 +1,33 @@
+import { IterableResolvable } from './from.cjs';
+
+/**
+ * Advances the iterable until it finds a matching element, returning `true` if it's found and `false` otherwise.
+ *
+ * @param iterable An iterator to search for a value in.
+ * @param callbackFn A function to execute for each element produced by the iterator. It should return a truthy value to
+ * indicate the element passes the test, and a falsy value otherwise.
+ * @returns `true` if the callback function returns a truthy value for at least one element. Otherwise, `false`.
+ *
+ * @example
+ * ```typescript
+ * import { some } from '@sapphire/iterator-utilities';
+ *
+ * const iterable = [1, 2, 3, 4, 5];
+ * console.log(some(iterable, (value) => value % 2 === 0));
+ * // Output: true
+ * ```
+ *
+ * @example
+ * ```typescript
+ * const iterable = [1, 2, 3, 4, 5];
+ * console.log(some(iterable, (value) => value % 6 === 0));
+ * // Output: false
+ * ```
+ *
+ * @remarks
+ *
+ * This function consumes the iterator until the value is found or the iterator is exhausted.
+ */
+declare function some<const ElementType>(iterable: IterableResolvable<ElementType>, callbackFn: (element: ElementType, index: number) => boolean): boolean;
+
+export { some };

package/dist/cjs/lib/sorted.cjs

@@ -0,0 +1,14 @@
+'use strict';
+
+var toArray_cjs = require('./toArray.cjs');
+
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+function sorted(iterable, compareFn) {
+  return toArray_cjs.toArray(iterable).sort(compareFn).values();
+}
+__name(sorted, "sorted");
+
+exports.sorted = sorted;
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=sorted.cjs.map

package/dist/cjs/lib/sorted.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/lib/sorted.ts"],"names":[],"mappings":";;;;AACA,SAAS,eAAe;AAsBjB,SAAS,OACf,UACA,WACgC;AAChC,SAAO,QAAQ,QAAQ,EAAE,KAAK,SAAS,EAAE,OAAO;AACjD;AALgB","sourcesContent":["import type { IterableResolvable } from './from';\nimport { toArray } from './toArray';\n\n/**\n * Consumes the iterable and returns a new iterable with the elements sorted.\n *\n * @param iterable An iterator to sort.\n * @param compareFn A function that defines the sort order. If omitted, the values are sorted in ascending order.\n * @returns An iterator that yields the values of the provided iterator in sorted order.\n *\n * @example\n * ```typescript\n * import { sorted } from '@sapphire/iterator-utilities';\n *\n * const iterable = [5, 3, 1, 4, 2];\n * console.log([...sorted(iterable)]);\n * // Output: [1, 2, 3, 4, 5]\n * ```\n *\n * @remarks\n *\n * This function consumes the entire input iterator.\n */\nexport function sorted<const ElementType>(\n\titerable: IterableResolvable<ElementType>,\n\tcompareFn?: (a: ElementType, b: ElementType) => number\n): IterableIterator<ElementType> {\n\treturn toArray(iterable).sort(compareFn).values();\n}\n"]}

package/dist/cjs/lib/sorted.d.cts

@@ -0,0 +1,25 @@
+import { IterableResolvable } from './from.cjs';
+
+/**
+ * Consumes the iterable and returns a new iterable with the elements sorted.
+ *
+ * @param iterable An iterator to sort.
+ * @param compareFn A function that defines the sort order. If omitted, the values are sorted in ascending order.
+ * @returns An iterator that yields the values of the provided iterator in sorted order.
+ *
+ * @example
+ * ```typescript
+ * import { sorted } from '@sapphire/iterator-utilities';
+ *
+ * const iterable = [5, 3, 1, 4, 2];
+ * console.log([...sorted(iterable)]);
+ * // Output: [1, 2, 3, 4, 5]
+ * ```
+ *
+ * @remarks
+ *
+ * This function consumes the entire input iterator.
+ */
+declare function sorted<const ElementType>(iterable: IterableResolvable<ElementType>, compareFn?: (a: ElementType, b: ElementType) => number): IterableIterator<ElementType>;
+
+export { sorted };

package/dist/cjs/lib/starMap.cjs

@@ -0,0 +1,19 @@
+'use strict';
+
+require('./from.cjs');
+var _assertFunction_cjs = require('./shared/_assertFunction.cjs');
+var toIterableIterator_cjs = require('./toIterableIterator.cjs');
+
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+function* starMap(iterable, callbackFn) {
+  callbackFn = _assertFunction_cjs.assertFunction(callbackFn);
+  for (const value of toIterableIterator_cjs.toIterableIterator(iterable)) {
+    yield callbackFn(...toIterableIterator_cjs.toIterableIterator(value));
+  }
+}
+__name(starMap, "starMap");
+
+exports.starMap = starMap;
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=starMap.cjs.map

package/dist/cjs/lib/starMap.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/lib/starMap.ts"],"names":[],"mappings":";;;;AAAA,OAAwC;AACxC,SAAS,sBAAsB;AAC/B,SAAS,0BAA0B;AAwB5B,UAAU,QAChB,UACA,YAC+B;AAC/B,eAAa,eAAe,UAAU;AAEtC,aAAW,SAAS,mBAAmB,QAAQ,GAAG;AACjD,UAAM,WAAW,GAAI,mBAAmB,KAAK,CAAS;AAAA,EACvD;AACD;AATiB","sourcesContent":["import { type IterableResolvable } from './from';\nimport { assertFunction } from './shared/_assertFunction';\nimport { toIterableIterator } from './toIterableIterator';\n\n/**\n * Creates an iterable with the results of calling a provided function on each element of the input iterables as the function's parameters.\n *\n * @param iterable The iterable to map over.\n * @param callbackFn The callback function to apply to each element.\n * @returns An iterable iterator that yields the mapped elements.\n *\n * @example\n * ```typescript\n * import { starMap } from '@sapphire/iterator-utilities';\n *\n * const iterable = [[1, 2], [3, 4], [5, 6]];\n * console.log([...starMap(iterable, (a, b) => a + b)]);\n * // Output: [3, 7, 11]\n * ```\n *\n * @remarks\n *\n * While very similar to {@link map}, `starMap` takes an iterable of iterables (which can be an array of tuples) and\n * calls the function with each inner iterable's values as the function's parameters. {@link map} calls the function\n * with the value and the index by comparison.\n */\nexport function* starMap<const ElementType extends IterableResolvable<any>, const MappedType>(\n\titerable: IterableResolvable<ElementType>,\n\tcallbackFn: (...args: StarMapParameters<ElementType>) => MappedType\n): IterableIterator<MappedType> {\n\tcallbackFn = assertFunction(callbackFn);\n\n\tfor (const value of toIterableIterator(iterable)) {\n\t\tyield callbackFn(...(toIterableIterator(value) as any));\n\t}\n}\n\nexport type StarMapParameters<ElementType> = ElementType extends readonly [...infer ElementTypeEntry]\n\t? ElementTypeEntry\n\t: ElementType extends IterableResolvable<infer ElementType>\n\t\t? ElementType[]\n\t\t: never;\n"]}

package/dist/cjs/lib/starMap.d.cts

@@ -0,0 +1,28 @@
+import { IterableResolvable } from './from.cjs';
+
+/**
+ * Creates an iterable with the results of calling a provided function on each element of the input iterables as the function's parameters.
+ *
+ * @param iterable The iterable to map over.
+ * @param callbackFn The callback function to apply to each element.
+ * @returns An iterable iterator that yields the mapped elements.
+ *
+ * @example
+ * ```typescript
+ * import { starMap } from '@sapphire/iterator-utilities';
+ *
+ * const iterable = [[1, 2], [3, 4], [5, 6]];
+ * console.log([...starMap(iterable, (a, b) => a + b)]);
+ * // Output: [3, 7, 11]
+ * ```
+ *
+ * @remarks
+ *
+ * While very similar to {@link map}, `starMap` takes an iterable of iterables (which can be an array of tuples) and
+ * calls the function with each inner iterable's values as the function's parameters. {@link map} calls the function
+ * with the value and the index by comparison.
+ */
+declare function starMap<const ElementType extends IterableResolvable<any>, const MappedType>(iterable: IterableResolvable<ElementType>, callbackFn: (...args: StarMapParameters<ElementType>) => MappedType): IterableIterator<MappedType>;
+type StarMapParameters<ElementType> = ElementType extends readonly [...infer ElementTypeEntry] ? ElementTypeEntry : ElementType extends IterableResolvable<infer ElementType> ? ElementType[] : never;
+
+export { type StarMapParameters, starMap };

package/dist/cjs/lib/sum.cjs

@@ -0,0 +1,19 @@
+'use strict';
+
+var map_cjs = require('./map.cjs');
+var _toNumberOrThrow_cjs = require('./shared/_toNumberOrThrow.cjs');
+
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+function sum(iterable) {
+  let sum2 = 0;
+  for (const value of map_cjs.map(iterable, _toNumberOrThrow_cjs.toNumberOrThrow)) {
+    sum2 += value;
+  }
+  return sum2;
+}
+__name(sum, "sum");
+
+exports.sum = sum;
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=sum.cjs.map

package/dist/cjs/lib/sum.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/lib/sum.ts"],"names":["sum"],"mappings":";;;;AACA,SAAS,WAAW;AACpB,SAAS,uBAA8C;AAqBhD,SAAS,IAAI,UAAgD;AACnE,MAAIA,OAAM;AACV,aAAW,SAAS,IAAI,UAAU,eAAe,GAAG;AACnD,IAAAA,QAAO;AAAA,EACR;AAEA,SAAOA;AACR;AAPgB","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 sum of all the elements.\n *\n * @param iterable An iterator of numbers to calculate the sum of.\n * @returns The sum of the numbers in the input iterator.\n *\n * @example\n * ```typescript\n * import { sum } from '@sapphire/iterator-utilities';\n *\n * const iterable = [1, 2, 3, 4, 5];\n * console.log(sum(iterable));\n * // Output: 15\n * ```\n *\n * @remarks\n *\n * This function consumes the entire iterator.\n */\nexport function sum(iterable: IterableResolvable<NumberResolvable>) {\n\tlet sum = 0;\n\tfor (const value of map(iterable, toNumberOrThrow)) {\n\t\tsum += value;\n\t}\n\n\treturn sum;\n}\n"]}

package/dist/cjs/lib/sum.d.cts

@@ -0,0 +1,25 @@
+import { IterableResolvable } from './from.cjs';
+import { NumberResolvable } from './shared/_toNumberOrThrow.js';
+
+/**
+ * Consumes the iterable and returns the sum of all the elements.
+ *
+ * @param iterable An iterator of numbers to calculate the sum of.
+ * @returns The sum of the numbers in the input iterator.
+ *
+ * @example
+ * ```typescript
+ * import { sum } from '@sapphire/iterator-utilities';
+ *
+ * const iterable = [1, 2, 3, 4, 5];
+ * console.log(sum(iterable));
+ * // Output: 15
+ * ```
+ *
+ * @remarks
+ *
+ * This function consumes the entire iterator.
+ */
+declare function sum(iterable: IterableResolvable<NumberResolvable>): number;
+
+export { sum };

package/dist/cjs/lib/take.cjs

@@ -0,0 +1,25 @@
+'use strict';
+
+var empty_cjs = require('./empty.cjs');
+var from_cjs = require('./from.cjs');
+var _assertNotNegative_cjs = require('./shared/_assertNotNegative.cjs');
+var _makeIterableIterator_cjs = require('./shared/_makeIterableIterator.cjs');
+var _toIntegerOrInfinityOrThrow_cjs = require('./shared/_toIntegerOrInfinityOrThrow.cjs');
+
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+function take(iterable, count) {
+  count = _assertNotNegative_cjs.assertNotNegative(_toIntegerOrInfinityOrThrow_cjs.toIntegerOrInfinityOrThrow(count), count);
+  if (count === 0)
+    return empty_cjs.empty();
+  let i = 0;
+  const resolvedIterable = from_cjs.from(iterable);
+  return _makeIterableIterator_cjs.makeIterableIterator(
+    () => i >= count ? { done: true, value: void 0 } : (i++, resolvedIterable.next())
+  );
+}
+__name(take, "take");
+
+exports.take = take;
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=take.cjs.map

package/dist/cjs/lib/take.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/lib/take.ts"],"names":[],"mappings":";;;;AAAA,SAAS,aAAa;AACtB,SAAS,YAAqC;AAC9C,SAAS,yBAAyB;AAClC,SAAS,4BAA4B;AACrC,SAAS,kCAAkC;AAkBpC,SAAS,KAAwB,UAA2C,OAA8C;AAChI,UAAQ,kBAAkB,2BAA2B,KAAK,GAAG,KAAK;AAClE,MAAI,UAAU;AAAG,WAAO,MAAM;AAE9B,MAAI,IAAI;AACR,QAAM,mBAAmB,KAAK,QAAQ;AACtC,SAAO;AAAA,IAAkC,MACxC,KAAK,QACF,EAAE,MAAM,MAAM,OAAO,OAAU,KAC9B,KAAK,iBAAiB,KAAK;AAAA,EAChC;AACD;AAXgB","sourcesContent":["import { empty } from './empty';\nimport { from, type IterableResolvable } from './from';\nimport { assertNotNegative } from './shared/_assertNotNegative';\nimport { makeIterableIterator } from './shared/_makeIterableIterator';\nimport { toIntegerOrInfinityOrThrow } from './shared/_toIntegerOrInfinityOrThrow';\n\n/**\n * Creates an iterable with the first `count` elements.\n *\n * @param iterable The iterator to take values from.\n * @param count The maximum number of values to take from the iterator.\n * @returns An iterator that yields at most `count` values from the provided iterator.\n *\n * @example\n * ```typescript\n * import { take } from '@sapphire/iterator-utilities';\n *\n * const iterable = [1, 2, 3, 4, 5];\n * console.log([...take(iterable, 2)]);\n * // Output: [1, 2]\n * ```\n */\nexport function take<const ElementType>(iterable: IterableResolvable<ElementType>, count: number): IterableIterator<ElementType> {\n\tcount = assertNotNegative(toIntegerOrInfinityOrThrow(count), count);\n\tif (count === 0) return empty();\n\n\tlet i = 0;\n\tconst resolvedIterable = from(iterable);\n\treturn makeIterableIterator<ElementType>(() =>\n\t\ti >= count //\n\t\t\t? { done: true, value: undefined }\n\t\t\t: (i++, resolvedIterable.next())\n\t);\n}\n"]}