@sapphire/iterator-utilities 1.0.0

package/dist/esm/lib/reduce.mjs

@@ -0,0 +1,29 @@
+import { __name } from '../chunk-G5GHKT7C.mjs';
+import { assertFunction } from './shared/_assertFunction.mjs';
+import { toIterableIterator } from './toIterableIterator.mjs';
+
+function reduce(iterable, callbackFn, initialValue) {
+  callbackFn = assertFunction(callbackFn);
+  let index;
+  let accumulator;
+  const resolvedIterable = toIterableIterator(iterable);
+  if (arguments.length < 3) {
+    const firstValue = resolvedIterable.next();
+    if (firstValue.done)
+      throw new TypeError("Reduce of empty iterator with no initial value");
+    index = 1;
+    accumulator = firstValue.value;
+  } else {
+    index = 0;
+    accumulator = initialValue;
+  }
+  for (const value of resolvedIterable) {
+    accumulator = callbackFn(accumulator, value, index++);
+  }
+  return accumulator;
+}
+__name(reduce, "reduce");
+
+export { reduce };
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=reduce.mjs.map

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

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/lib/reduce.ts"],"names":[],"mappings":";;;;;AACA,SAAS,sBAAsB;AAC/B,SAAS,0BAA0B;AA8B5B,SAAS,OACf,UACA,YACA,cACa;AACb,eAAa,eAAe,UAAU;AAEtC,MAAI;AACJ,MAAI;AACJ,QAAM,mBAAmB,mBAAmB,QAAQ;AACpD,MAAI,UAAU,SAAS,GAAG;AACzB,UAAM,aAAa,iBAAiB,KAAK;AACzC,QAAI,WAAW;AAAM,YAAM,IAAI,UAAU,gDAAgD;AAEzF,YAAQ;AACR,kBAAc,WAAW;AAAA,EAC1B,OAAO;AACN,YAAQ;AACR,kBAAc;AAAA,EACf;AAEA,aAAW,SAAS,kBAAkB;AACrC,kBAAc,WAAW,aAAa,OAAO,OAAO;AAAA,EACrD;AAEA,SAAO;AACR;AA1BgB","sourcesContent":["import type { IterableResolvable } from './from';\nimport { assertFunction } from './shared/_assertFunction';\nimport { toIterableIterator } from './toIterableIterator';\n\n/**\n * Consumes the iterable and reduces it to the reducer function's result.\n *\n * @param iterable An iterator to reduce.\n * @param callbackFn A function to execute for each element produced by the iterator. Its return value becomes the value\n * of the `accumulator` parameter on the next invocation of `callbackFn`. For the last invocation, the return value\n * becomes the return value of `reduce()`.\n * @param initialValue A value to which `accumulator` is initialized the first time the callback is called. If\n * `initialValue` is specified, `callbackFn` starts executing with the first element as `currentValue`. If\n * `initialValue` is not specified, `accumulator` is initialized to the first element, and `callbackFn` starts executing\n * with the second element as `currentValue`. In this case, if the iterator is empty (so that there's no first value to\n * return as `accumulator`), an error is thrown.\n * @returns\n *\n * @example\n * ```typescript\n * import { reduce } from '@sapphire/iterator-utilities';\n *\n * const iterable = [1, 2, 3, 4, 5];\n * console.log(reduce(iterable, (accumulator, currentValue) => accumulator + currentValue));\n * // Output: 15\n * ```\n *\n * @remarks\n *\n * If `initialValue` is not provided, the first element of the iterator is used as the initial value of `accumulator`,\n * consuming the first element.\n */\nexport function reduce<const ElementType, const MappedType>(\n\titerable: IterableResolvable<ElementType>,\n\tcallbackFn: (accumulator: MappedType, currentValue: ElementType, currentIndex: number) => MappedType,\n\tinitialValue?: MappedType\n): MappedType {\n\tcallbackFn = assertFunction(callbackFn);\n\n\tlet index: number;\n\tlet accumulator: MappedType;\n\tconst resolvedIterable = toIterableIterator(iterable);\n\tif (arguments.length < 3) {\n\t\tconst firstValue = resolvedIterable.next();\n\t\tif (firstValue.done) throw new TypeError('Reduce of empty iterator with no initial value');\n\n\t\tindex = 1;\n\t\taccumulator = firstValue.value! as MappedType;\n\t} else {\n\t\tindex = 0;\n\t\taccumulator = initialValue!;\n\t}\n\n\tfor (const value of resolvedIterable) {\n\t\taccumulator = callbackFn(accumulator, value, index++);\n\t}\n\n\treturn accumulator;\n}\n"]}

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

@@ -0,0 +1,20 @@
+/**
+ * Creates an iterable that repeats the input iterable `count` times.
+ *
+ * @param value The value to be repeated.
+ * @param count The number of times to repeat the value.
+ *
+ * @example
+ * ```typescript
+ * import { repeat } from '@sapphire/iterator-utilities';
+ *
+ * const iterator = repeat('Hello, world!', 3);
+ * console.log([...iterator]);
+ * // Output: ['Hello, world!', 'Hello, world!', 'Hello, world!']
+ * ```
+ *
+ * @remarks This function does not clone `value`, it will be repeated as a reference.
+ */
+declare function repeat<const ElementType>(value: ElementType, count: number): IterableIterator<ElementType>;
+
+export { repeat };

package/dist/esm/lib/repeat.mjs

@@ -0,0 +1,17 @@
+import { __name } from '../chunk-G5GHKT7C.mjs';
+import { assertNotNegative } from './shared/_assertNotNegative.mjs';
+import { makeIterableIterator } from './shared/_makeIterableIterator.mjs';
+import { toNumberOrThrow } from './shared/_toNumberOrThrow.mjs';
+
+function repeat(value, count) {
+  count = assertNotNegative(toNumberOrThrow(count), count);
+  let i = 0;
+  return makeIterableIterator(
+    () => i >= count ? { done: true, value: void 0 } : (i++, { done: false, value })
+  );
+}
+__name(repeat, "repeat");
+
+export { repeat };
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=repeat.mjs.map

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

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/lib/repeat.ts"],"names":[],"mappings":";;;;;AAAA,SAAS,yBAAyB;AAClC,SAAS,4BAA4B;AACrC,SAAS,uBAAuB;AAmBzB,SAAS,OAA0B,OAAoB,OAA8C;AAC3G,UAAQ,kBAAkB,gBAAgB,KAAK,GAAG,KAAK;AAEvD,MAAI,IAAI;AACR,SAAO;AAAA,IAAkC,MACxC,KAAK,QACF,EAAE,MAAM,MAAM,OAAO,OAAU,KAC9B,KAAK,EAAE,MAAM,OAAO,MAAM;AAAA,EAC/B;AACD;AATgB","sourcesContent":["import { assertNotNegative } from './shared/_assertNotNegative';\nimport { makeIterableIterator } from './shared/_makeIterableIterator';\nimport { toNumberOrThrow } from './shared/_toNumberOrThrow';\n\n/**\n * Creates an iterable that repeats the input iterable `count` times.\n *\n * @param value The value to be repeated.\n * @param count The number of times to repeat the value.\n *\n * @example\n * ```typescript\n * import { repeat } from '@sapphire/iterator-utilities';\n *\n * const iterator = repeat('Hello, world!', 3);\n * console.log([...iterator]);\n * // Output: ['Hello, world!', 'Hello, world!', 'Hello, world!']\n * ```\n *\n * @remarks This function does not clone `value`, it will be repeated as a reference.\n */\nexport function repeat<const ElementType>(value: ElementType, count: number): IterableIterator<ElementType> {\n\tcount = assertNotNegative(toNumberOrThrow(count), count);\n\n\tlet i = 0;\n\treturn makeIterableIterator<ElementType>(() =>\n\t\ti >= count //\n\t\t\t? { done: true, value: undefined }\n\t\t\t: (i++, { done: false, value })\n\t);\n}\n"]}

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

@@ -0,0 +1,26 @@
+import { IterableResolvable } from './from.mjs';
+
+/**
+ * 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/esm/lib/reverse.mjs

@@ -0,0 +1,17 @@
+import { __name } from '../chunk-G5GHKT7C.mjs';
+import { toIterableIterator } from './toIterableIterator.mjs';
+
+function* reverse(iterable) {
+  const items = [];
+  for (const item of toIterableIterator(iterable)) {
+    items.push(item);
+  }
+  for (let i = items.length - 1; i >= 0; i--) {
+    yield items[i];
+  }
+}
+__name(reverse, "reverse");
+
+export { reverse };
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=reverse.mjs.map

package/dist/esm/lib/reverse.mjs.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/esm/lib/shared/_assertFunction.d.mts

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

package/dist/esm/lib/shared/_assertFunction.mjs

@@ -0,0 +1,14 @@
+import { __name } from '../../chunk-G5GHKT7C.mjs';
+
+// 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");
+
+export { assertFunction };
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=_assertFunction.mjs.map

package/dist/esm/lib/shared/_assertFunction.mjs.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/esm/lib/shared/_assertNotNegative.d.mts

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

package/dist/esm/lib/shared/_assertNotNegative.mjs

@@ -0,0 +1,14 @@
+import { __name } from '../../chunk-G5GHKT7C.mjs';
+
+// 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");
+
+export { assertNotNegative };
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=_assertNotNegative.mjs.map

package/dist/esm/lib/shared/_assertNotNegative.mjs.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/esm/lib/shared/_assertPositive.d.mts

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

package/dist/esm/lib/shared/_assertPositive.mjs

@@ -0,0 +1,14 @@
+import { __name } from '../../chunk-G5GHKT7C.mjs';
+
+// 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");
+
+export { assertPositive };
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=_assertPositive.mjs.map

package/dist/esm/lib/shared/_assertPositive.mjs.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/esm/lib/shared/_makeIterableIterator.d.mts

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

package/dist/esm/lib/shared/_makeIterableIterator.mjs

@@ -0,0 +1,16 @@
+import { __name } from '../../chunk-G5GHKT7C.mjs';
+
+// src/lib/shared/_makeIterableIterator.ts
+function makeIterableIterator(next) {
+  return {
+    next,
+    [Symbol.iterator]() {
+      return this;
+    }
+  };
+}
+__name(makeIterableIterator, "makeIterableIterator");
+
+export { makeIterableIterator };
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=_makeIterableIterator.mjs.map

package/dist/esm/lib/shared/_makeIterableIterator.mjs.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/esm/lib/shared/_toIntegerOrInfinityOrThrow.d.mts

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

package/dist/esm/lib/shared/_toIntegerOrInfinityOrThrow.mjs

@@ -0,0 +1,18 @@
+import { __name } from '../../chunk-G5GHKT7C.mjs';
+import { toNumberOrThrow } from './_toNumberOrThrow.mjs';
+
+function toIntegerOrInfinityOrThrow(value) {
+  const number = 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");
+
+export { toIntegerOrInfinityOrThrow };
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=_toIntegerOrInfinityOrThrow.mjs.map

package/dist/esm/lib/shared/_toIntegerOrInfinityOrThrow.mjs.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/esm/lib/shared/_toIntegerOrThrow.d.mts

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

package/dist/esm/lib/shared/_toIntegerOrThrow.mjs

@@ -0,0 +1,18 @@
+import { __name } from '../../chunk-G5GHKT7C.mjs';
+import { toNumberOrThrow } from './_toNumberOrThrow.mjs';
+
+function toIntegerOrThrow(value) {
+  const number = 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");
+
+export { toIntegerOrThrow };
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=_toIntegerOrThrow.mjs.map

package/dist/esm/lib/shared/_toIntegerOrThrow.mjs.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/esm/lib/shared/_toNumberOrThrow.d.mts

@@ -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/esm/lib/shared/_toNumberOrThrow.mjs

@@ -0,0 +1,31 @@
+import { __name } from '../../chunk-G5GHKT7C.mjs';
+
+// 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");
+
+export { toNumberOrThrow };
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=_toNumberOrThrow.mjs.map

package/dist/esm/lib/shared/_toNumberOrThrow.mjs.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/esm/lib/slice.d.mts

@@ -0,0 +1,62 @@
+import { IterableResolvable } from './from.mjs';
+
+/**
+ * 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/esm/lib/slice.mjs

@@ -0,0 +1,41 @@
+import { __name } from '../chunk-G5GHKT7C.mjs';
+import { drop } from './drop.mjs';
+import { dropLast } from './dropLast.mjs';
+import { empty } from './empty.mjs';
+import { toIntegerOrInfinityOrThrow } from './shared/_toIntegerOrInfinityOrThrow.mjs';
+import { take } from './take.mjs';
+import { takeLast } from './takeLast.mjs';
+
+function slice(iterable, start, end) {
+  start = toIntegerOrInfinityOrThrow(start ?? 0);
+  if (start === Number.NEGATIVE_INFINITY) {
+    start = 0;
+  }
+  if (end === void 0) {
+    return start >= 0 ? drop(iterable, start) : takeLast(iterable, -start);
+  }
+  end = toIntegerOrInfinityOrThrow(end);
+  if (end < 0) {
+    if (end === Number.NEGATIVE_INFINITY) {
+      return empty();
+    }
+    if (start === 0) {
+      return dropLast(iterable, -end);
+    }
+    if (start >= 0) {
+      return dropLast(drop(iterable, start), -end);
+    }
+    if (start >= end) {
+      return empty();
+    }
+    return take(takeLast(iterable, -start), end - start);
+  }
+  if (start >= end)
+    return empty();
+  return end === Number.POSITIVE_INFINITY ? drop(iterable, start) : take(drop(iterable, start), end - start);
+}
+__name(slice, "slice");
+
+export { slice };
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=slice.mjs.map

package/dist/esm/lib/slice.mjs.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/esm/lib/some.d.mts

@@ -0,0 +1,33 @@
+import { IterableResolvable } from './from.mjs';
+
+/**
+ * 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/esm/lib/some.mjs

@@ -0,0 +1,19 @@
+import { __name } from '../chunk-G5GHKT7C.mjs';
+import { assertFunction } from './shared/_assertFunction.mjs';
+import { toIterableIterator } from './toIterableIterator.mjs';
+
+function some(iterable, callbackFn) {
+  callbackFn = assertFunction(callbackFn);
+  let index = 0;
+  for (const value of toIterableIterator(iterable)) {
+    if (callbackFn(value, index++)) {
+      return true;
+    }
+  }
+  return false;
+}
+__name(some, "some");
+
+export { some };
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=some.mjs.map

package/dist/esm/lib/some.mjs.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/esm/lib/sorted.d.mts

@@ -0,0 +1,25 @@
+import { IterableResolvable } from './from.mjs';
+
+/**
+ * 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/esm/lib/sorted.mjs

@@ -0,0 +1,11 @@
+import { __name } from '../chunk-G5GHKT7C.mjs';
+import { toArray } from './toArray.mjs';
+
+function sorted(iterable, compareFn) {
+  return toArray(iterable).sort(compareFn).values();
+}
+__name(sorted, "sorted");
+
+export { sorted };
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=sorted.mjs.map

package/dist/esm/lib/sorted.mjs.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/esm/lib/starMap.d.mts

@@ -0,0 +1,28 @@
+import { IterableResolvable } from './from.mjs';
+
+/**
+ * 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/esm/lib/starMap.mjs

@@ -0,0 +1,16 @@
+import { __name } from '../chunk-G5GHKT7C.mjs';
+import './from.mjs';
+import { assertFunction } from './shared/_assertFunction.mjs';
+import { toIterableIterator } from './toIterableIterator.mjs';
+
+function* starMap(iterable, callbackFn) {
+  callbackFn = assertFunction(callbackFn);
+  for (const value of toIterableIterator(iterable)) {
+    yield callbackFn(...toIterableIterator(value));
+  }
+}
+__name(starMap, "starMap");
+
+export { starMap };
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=starMap.mjs.map

package/dist/esm/lib/starMap.mjs.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"]}