@sapphire/iterator-utilities 1.0.0

package/dist/cjs/lib/every.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/lib/every.ts"],"names":[],"mappings":";;;;AACA,SAAS,sBAAsB;AAC/B,SAAS,0BAA0B;AAiC5B,SAAS,MAAyB,UAA2C,YAA8D;AACjJ,eAAa,eAAe,UAAU;AAEtC,MAAI,QAAQ;AACZ,aAAW,SAAS,mBAAmB,QAAQ,GAAG;AACjD,QAAI,CAAC,WAAW,OAAO,OAAO;AAAG,aAAO;AAAA,EACzC;AAEA,SAAO;AACR;AATgB","sourcesContent":["import type { IterableResolvable } from './from';\nimport { assertFunction } from './shared/_assertFunction';\nimport { toIterableIterator } from './toIterableIterator';\n\n/**\n * Tests whether all elements in the iterable pass the test implemented by the provided function.\n *\n * @param iterable The iterator to check.\n * @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.\n * @returns `true` if callbackFn returns a truthy value for every element. Otherwise, `false`.\n *\n * @example\n * ```typescript\n * import { every } from '@sapphire/iterator-utilities';\n *\n * const iterable = [1, 2, 3, 4, 5];\n * console.log(every(iterable, (value) => value < 10));\n * // Output: true\n *\n * console.log(every(iterable, (value) => value < 3));\n * // Output: false\n * ```\n *\n * @remarks\n *\n * This function consumes the entire iterator.\n */\nexport function every<const ElementType, const FilteredType extends ElementType>(\n\titerable: IterableResolvable<ElementType>,\n\tcallbackFn: (element: ElementType, index: number) => element is FilteredType\n): iterable is IterableIterator<FilteredType>;\nexport function every<const ElementType>(\n\titerable: IterableResolvable<ElementType>,\n\tcallbackFn: (element: ElementType, index: number) => boolean\n): boolean;\nexport function every<const ElementType>(iterable: IterableResolvable<ElementType>, callbackFn: (element: ElementType, index: number) => boolean) {\n\tcallbackFn = assertFunction(callbackFn);\n\n\tlet index = 0;\n\tfor (const value of toIterableIterator(iterable)) {\n\t\tif (!callbackFn(value, index++)) return false;\n\t}\n\n\treturn true;\n}\n"]}

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

@@ -0,0 +1,29 @@
+import { IterableResolvable } from './from.cjs';
+
+/**
+ * Tests whether all elements in the iterable pass the test implemented by the provided function.
+ *
+ * @param iterable The iterator to check.
+ * @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 callbackFn returns a truthy value for every element. Otherwise, `false`.
+ *
+ * @example
+ * ```typescript
+ * import { every } from '@sapphire/iterator-utilities';
+ *
+ * const iterable = [1, 2, 3, 4, 5];
+ * console.log(every(iterable, (value) => value < 10));
+ * // Output: true
+ *
+ * console.log(every(iterable, (value) => value < 3));
+ * // Output: false
+ * ```
+ *
+ * @remarks
+ *
+ * This function consumes the entire iterator.
+ */
+declare function every<const ElementType, const FilteredType extends ElementType>(iterable: IterableResolvable<ElementType>, callbackFn: (element: ElementType, index: number) => element is FilteredType): iterable is IterableIterator<FilteredType>;
+declare function every<const ElementType>(iterable: IterableResolvable<ElementType>, callbackFn: (element: ElementType, index: number) => boolean): boolean;
+
+export { every };

package/dist/cjs/lib/filter.cjs

@@ -0,0 +1,21 @@
+'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* filter(iterable, callbackFn) {
+  callbackFn = _assertFunction_cjs.assertFunction(callbackFn);
+  let index = 0;
+  for (const value of toIterableIterator_cjs.toIterableIterator(iterable)) {
+    if (callbackFn(value, index++))
+      yield value;
+  }
+}
+__name(filter, "filter");
+
+exports.filter = filter;
+exports.takeWhile = filter;
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=filter.cjs.map

package/dist/cjs/lib/filter.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/lib/filter.ts"],"names":[],"mappings":";;;;AACA,SAAS,sBAAsB;AAC/B,SAAS,0BAA0B;AA0B5B,UAAU,OAChB,UACA,YACgC;AAChC,eAAa,eAAe,UAAU;AAEtC,MAAI,QAAQ;AACZ,aAAW,SAAS,mBAAmB,QAAQ,GAAG;AACjD,QAAI,WAAW,OAAO,OAAO;AAAG,YAAM;AAAA,EACvC;AACD;AAViB","sourcesContent":["import type { IterableResolvable } from './from';\nimport { assertFunction } from './shared/_assertFunction';\nimport { toIterableIterator } from './toIterableIterator';\n\n/**\n * Creates an iterable with the elements that pass the test implemented by the provided function.\n *\n * @param iterable The iterator to filter.\n * @param callbackFn A function to execute for each element produced by the iterator. It should return a truthy value to make the element yielded by the iterator helper, and a falsy value otherwise.\n * @returns An iterator that produces elements from the given iterator that satisfy the specified test.\n *\n * @example\n * ```typescript\n * import { filter } from '@sapphire/iterator-utilities';\n *\n * const iterable = [1, 2, 3, 4, 5];\n * console.log([...filter(iterable, (value) => value % 2 === 0)]);\n * // Output: [2, 4]\n * ```\n */\nexport function filter<const ElementType, const FilteredType extends ElementType>(\n\titerable: IterableResolvable<ElementType>,\n\tcallbackFn: (element: ElementType, index: number) => element is FilteredType\n): IterableIterator<FilteredType>;\nexport function filter<const ElementType>(\n\titerable: IterableResolvable<ElementType>,\n\tcallbackFn: (element: ElementType, index: number) => boolean\n): IterableIterator<ElementType>;\nexport function* filter<ElementType>(\n\titerable: IterableResolvable<ElementType>,\n\tcallbackFn: (element: ElementType, index: number) => boolean\n): IterableIterator<ElementType> {\n\tcallbackFn = assertFunction(callbackFn);\n\n\tlet index = 0;\n\tfor (const value of toIterableIterator(iterable)) {\n\t\tif (callbackFn(value, index++)) yield value;\n\t}\n}\n\nexport { filter as takeWhile };\n"]}

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

@@ -0,0 +1,22 @@
+import { IterableResolvable } from './from.cjs';
+
+/**
+ * Creates an iterable with the elements that pass the test implemented by the provided function.
+ *
+ * @param iterable The iterator to filter.
+ * @param callbackFn A function to execute for each element produced by the iterator. It should return a truthy value to make the element yielded by the iterator helper, and a falsy value otherwise.
+ * @returns An iterator that produces elements from the given iterator that satisfy the specified test.
+ *
+ * @example
+ * ```typescript
+ * import { filter } from '@sapphire/iterator-utilities';
+ *
+ * const iterable = [1, 2, 3, 4, 5];
+ * console.log([...filter(iterable, (value) => value % 2 === 0)]);
+ * // Output: [2, 4]
+ * ```
+ */
+declare function filter<const ElementType, const FilteredType extends ElementType>(iterable: IterableResolvable<ElementType>, callbackFn: (element: ElementType, index: number) => element is FilteredType): IterableIterator<FilteredType>;
+declare function filter<const ElementType>(iterable: IterableResolvable<ElementType>, callbackFn: (element: ElementType, index: number) => boolean): IterableIterator<ElementType>;
+
+export { filter, filter as takeWhile };

package/dist/cjs/lib/find.cjs

@@ -0,0 +1,15 @@
+'use strict';
+
+var filter_cjs = require('./filter.cjs');
+var first_cjs = require('./first.cjs');
+
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+function find(iterable, callbackFn) {
+  return first_cjs.first(filter_cjs.filter(iterable, callbackFn));
+}
+__name(find, "find");
+
+exports.find = find;
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=find.cjs.map

package/dist/cjs/lib/find.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/lib/find.ts"],"names":[],"mappings":";;;;AAAA,SAAS,cAAc;AACvB,SAAS,aAAa;AA+Bf,SAAS,KACf,UACA,YAC0B;AAC1B,SAAO,MAAM,OAAO,UAAU,UAAU,CAAC;AAC1C;AALgB","sourcesContent":["import { filter } from './filter';\nimport { first } from './first';\nimport type { IterableResolvable } from './from';\n\n/**\n * Advances the iterable until it finds the element, returning it if it's found and `undefined` otherwise.\n *\n * @param iterable An iterator to search for a value in.\n * @param callbackFn A function that determines if a value is the one being searched for.\n * @returns\n *\n * @example\n * ```typescript\n * import { find } from '@sapphire/iterator-utilities';\n *\n * const iterable = [1, 2, 3, 4, 5];\n * console.log(find(iterable, (value) => value % 2 === 0));\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 find<const ElementType, const FilteredType extends ElementType>(\n\titerable: IterableResolvable<ElementType>,\n\tcallbackFn: (element: ElementType, index: number) => element is FilteredType\n): FilteredType | undefined;\nexport function find<const ElementType>(\n\titerable: IterableResolvable<ElementType>,\n\tcallbackFn: (element: ElementType, index: number) => boolean\n): ElementType | undefined;\nexport function find<const ElementType>(\n\titerable: IterableResolvable<ElementType>,\n\tcallbackFn: (element: ElementType, index: number) => boolean\n): ElementType | undefined {\n\treturn first(filter(iterable, callbackFn));\n}\n"]}

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

@@ -0,0 +1,26 @@
+import { IterableResolvable } from './from.cjs';
+
+/**
+ * Advances the iterable until it finds the element, returning it if it's found and `undefined` otherwise.
+ *
+ * @param iterable An iterator to search for a value in.
+ * @param callbackFn A function that determines if a value is the one being searched for.
+ * @returns
+ *
+ * @example
+ * ```typescript
+ * import { find } from '@sapphire/iterator-utilities';
+ *
+ * const iterable = [1, 2, 3, 4, 5];
+ * console.log(find(iterable, (value) => value % 2 === 0));
+ * // Output: 2
+ * ```
+ *
+ * @remarks
+ *
+ * This function consumes the iterator until the value is found or the iterator is exhausted.
+ */
+declare function find<const ElementType, const FilteredType extends ElementType>(iterable: IterableResolvable<ElementType>, callbackFn: (element: ElementType, index: number) => element is FilteredType): FilteredType | undefined;
+declare function find<const ElementType>(iterable: IterableResolvable<ElementType>, callbackFn: (element: ElementType, index: number) => boolean): ElementType | undefined;
+
+export { find };

package/dist/cjs/lib/findIndex.cjs

@@ -0,0 +1,23 @@
+'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 findIndex(iterable, callbackFn) {
+  callbackFn = _assertFunction_cjs.assertFunction(callbackFn);
+  let index = 0;
+  for (const element of toIterableIterator_cjs.toIterableIterator(iterable)) {
+    if (callbackFn(element, index)) {
+      return index;
+    }
+    index++;
+  }
+  return -1;
+}
+__name(findIndex, "findIndex");
+
+exports.findIndex = findIndex;
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=findIndex.cjs.map

package/dist/cjs/lib/findIndex.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/lib/findIndex.ts"],"names":[],"mappings":";;;;AACA,SAAS,sBAAsB;AAC/B,SAAS,0BAA0B;AAsB5B,SAAS,UACf,UACA,YACS;AACT,eAAa,eAAe,UAAU;AAEtC,MAAI,QAAQ;AACZ,aAAW,WAAW,mBAAmB,QAAQ,GAAG;AACnD,QAAI,WAAW,SAAS,KAAK,GAAG;AAC/B,aAAO;AAAA,IACR;AAEA;AAAA,EACD;AAEA,SAAO;AACR;AAhBgB","sourcesContent":["import type { IterableResolvable } from './from';\nimport { assertFunction } from './shared/_assertFunction';\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 an element in.\n * @param callbackFn A function that determines if an element is the one being searched for.\n * @returns The index of the first element that satisfies the predicate, or `-1` if no elements satisfy the predicate.\n *\n * @example\n * ```typescript\n * import { findIndex } from '@sapphire/iterator-utilities';\n *\n * const iterable = [1, 2, 3, 4, 5];\n * console.log(findIndex(iterable, (value) => value % 2 === 0));\n * // Output: 1\n * ```\n *\n * @remarks\n *\n * This function consumes the iterator until the value is found or the iterator is exhausted.\n */\nexport function findIndex<const ElementType>(\n\titerable: IterableResolvable<ElementType>,\n\tcallbackFn: (element: ElementType, index: number) => boolean\n): number {\n\tcallbackFn = assertFunction(callbackFn);\n\n\tlet index = 0;\n\tfor (const element of toIterableIterator(iterable)) {\n\t\tif (callbackFn(element, index)) {\n\t\t\treturn index;\n\t\t}\n\n\t\tindex++;\n\t}\n\n\treturn -1;\n}\n"]}

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

@@ -0,0 +1,25 @@
+import { IterableResolvable } from './from.cjs';
+
+/**
+ * Advances the iterable until it finds the element, returning its index if it's found and `-1` otherwise.
+ *
+ * @param iterable An iterator to search for an element in.
+ * @param callbackFn A function that determines if an element is the one being searched for.
+ * @returns The index of the first element that satisfies the predicate, or `-1` if no elements satisfy the predicate.
+ *
+ * @example
+ * ```typescript
+ * import { findIndex } from '@sapphire/iterator-utilities';
+ *
+ * const iterable = [1, 2, 3, 4, 5];
+ * console.log(findIndex(iterable, (value) => value % 2 === 0));
+ * // Output: 1
+ * ```
+ *
+ * @remarks
+ *
+ * This function consumes the iterator until the value is found or the iterator is exhausted.
+ */
+declare function findIndex<const ElementType>(iterable: IterableResolvable<ElementType>, callbackFn: (element: ElementType, index: number) => boolean): number;
+
+export { findIndex };

package/dist/cjs/lib/first.cjs

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

package/dist/cjs/lib/first.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/lib/first.ts"],"names":[],"mappings":";;;;AAAA,SAAS,YAAqC;AAqBvC,SAAS,MAAyB,UAAoE;AAC5G,SAAO,KAAK,QAAQ,EAAE,KAAK,EAAE;AAC9B;AAFgB","sourcesContent":["import { from, type IterableResolvable } from './from';\n\n/**\n * Consumes the first element of the iterable, returning it if it's found and `undefined` otherwise.\n *\n * @param iterable The iterator to return the first value of.\n * @returns The first value of the iterator, or `undefined` if the iterator is empty.\n *\n * @example\n * ```typescript\n * import { first } from '@sapphire/iterator-utilities';\n *\n * const iterable = [1, 2, 3, 4, 5];\n * console.log(first(iterable));\n * // Output: 1\n * ```\n *\n * @remarks\n *\n * This function consumes the first value of the iterator.\n */\nexport function first<const ElementType>(iterable: IterableResolvable<ElementType>): ElementType | undefined {\n\treturn from(iterable).next().value;\n}\n"]}

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

@@ -0,0 +1,24 @@
+import { IterableResolvable } from './from.cjs';
+
+/**
+ * Consumes the first element of the iterable, returning it if it's found and `undefined` otherwise.
+ *
+ * @param iterable The iterator to return the first value of.
+ * @returns The first value of the iterator, or `undefined` if the iterator is empty.
+ *
+ * @example
+ * ```typescript
+ * import { first } from '@sapphire/iterator-utilities';
+ *
+ * const iterable = [1, 2, 3, 4, 5];
+ * console.log(first(iterable));
+ * // Output: 1
+ * ```
+ *
+ * @remarks
+ *
+ * This function consumes the first value of the iterator.
+ */
+declare function first<const ElementType>(iterable: IterableResolvable<ElementType>): ElementType | undefined;
+
+export { first };

package/dist/cjs/lib/flat.cjs

@@ -0,0 +1,16 @@
+'use strict';
+
+var toIterableIterator_cjs = require('./toIterableIterator.cjs');
+
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+function* flat(iterables) {
+  for (const value of toIterableIterator_cjs.toIterableIterator(iterables)) {
+    yield* toIterableIterator_cjs.toIterableIterator(value);
+  }
+}
+__name(flat, "flat");
+
+exports.flat = flat;
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=flat.cjs.map

package/dist/cjs/lib/flat.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/lib/flat.ts"],"names":[],"mappings":";;;;AACA,SAAS,0BAA0B;AAiB5B,UAAU,KAAwB,WAA+F;AACvI,aAAW,SAAS,mBAAmB,SAAS,GAAG;AAClD,WAAO,mBAAmB,KAAK;AAAA,EAChC;AACD;AAJiB","sourcesContent":["import type { IterableResolvable } from './from';\nimport { toIterableIterator } from './toIterableIterator';\n\n/**\n * Creates an iterable that yields the elements of each iterable in the input iterable.\n *\n * @param iterables An iterator to map.\n * @returns An iterator that yields the entries of each iterator.\n *\n * @example\n * ```typescript\n * import { flat } from '@sapphire/iterator-utilities';\n *\n * const iterable = flat([[1, 2], [3, 4], [5, 6]]);\n * console.log([...iterable]);\n * // Output: [1, 2, 3, 4, 5, 6]\n * ```\n */\nexport function* flat<const ElementType>(iterables: IterableResolvable<IterableResolvable<ElementType>>): IterableIterator<ElementType> {\n\tfor (const value of toIterableIterator(iterables)) {\n\t\tyield* toIterableIterator(value);\n\t}\n}\n"]}

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

@@ -0,0 +1,20 @@
+import { IterableResolvable } from './from.cjs';
+
+/**
+ * Creates an iterable that yields the elements of each iterable in the input iterable.
+ *
+ * @param iterables An iterator to map.
+ * @returns An iterator that yields the entries of each iterator.
+ *
+ * @example
+ * ```typescript
+ * import { flat } from '@sapphire/iterator-utilities';
+ *
+ * const iterable = flat([[1, 2], [3, 4], [5, 6]]);
+ * console.log([...iterable]);
+ * // Output: [1, 2, 3, 4, 5, 6]
+ * ```
+ */
+declare function flat<const ElementType>(iterables: IterableResolvable<IterableResolvable<ElementType>>): IterableIterator<ElementType>;
+
+export { flat };

package/dist/cjs/lib/flatMap.cjs

@@ -0,0 +1,19 @@
+'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* flatMap(iterable, callbackFn) {
+  callbackFn = _assertFunction_cjs.assertFunction(callbackFn);
+  let index = 0;
+  for (const value of toIterableIterator_cjs.toIterableIterator(iterable)) {
+    yield* toIterableIterator_cjs.toIterableIterator(callbackFn(value, index++));
+  }
+}
+__name(flatMap, "flatMap");
+
+exports.flatMap = flatMap;
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=flatMap.cjs.map

package/dist/cjs/lib/flatMap.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/lib/flatMap.ts"],"names":[],"mappings":";;;;AACA,SAAS,sBAAsB;AAC/B,SAAS,0BAA0B;AAkB5B,UAAU,QAChB,UACA,YAC+B;AAC/B,eAAa,eAAe,UAAU;AAEtC,MAAI,QAAQ;AACZ,aAAW,SAAS,mBAAmB,QAAQ,GAAG;AACjD,WAAO,mBAAmB,WAAW,OAAO,OAAO,CAAC;AAAA,EACrD;AACD;AAViB","sourcesContent":["import type { IterableResolvable } from './from';\nimport { assertFunction } from './shared/_assertFunction';\nimport { toIterableIterator } from './toIterableIterator';\n\n/**\n * Creates an iterable that yields the elements of each iterable returned by the provided function on each element of the input iterable.\n *\n * @param iterable An iterator to map.\n * @param callbackFn A function to execute for each element produced by the iterator. It should return an iterator or iterable that yields elements to be yielded by `flatMap()`, or a single non-iterator/iterable value to be yielded.\n * @returns An iterator that applies a function to each element of the input iterator and yields the results.\n *\n * @example\n * ```typescript\n * import { flatMap } from '@sapphire/iterator-utilities';\n *\n * const iterable = [1, 2, 3];\n * console.log([...flatMap(iterable, (value) => [value, value * 2])]);\n * // Output: [1, 2, 2, 4, 3, 6]\n * ```\n */\nexport function* flatMap<const ElementType, const MappedType>(\n\titerable: IterableResolvable<ElementType>,\n\tcallbackFn: (element: ElementType, index: number) => IterableResolvable<MappedType>\n): IterableIterator<MappedType> {\n\tcallbackFn = assertFunction(callbackFn);\n\n\tlet index = 0;\n\tfor (const value of toIterableIterator(iterable)) {\n\t\tyield* toIterableIterator(callbackFn(value, index++));\n\t}\n}\n"]}

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

@@ -0,0 +1,21 @@
+import { IterableResolvable } from './from.cjs';
+
+/**
+ * Creates an iterable that yields the elements of each iterable returned by the provided function on each element of the input iterable.
+ *
+ * @param iterable An iterator to map.
+ * @param callbackFn A function to execute for each element produced by the iterator. It should return an iterator or iterable that yields elements to be yielded by `flatMap()`, or a single non-iterator/iterable value to be yielded.
+ * @returns An iterator that applies a function to each element of the input iterator and yields the results.
+ *
+ * @example
+ * ```typescript
+ * import { flatMap } from '@sapphire/iterator-utilities';
+ *
+ * const iterable = [1, 2, 3];
+ * console.log([...flatMap(iterable, (value) => [value, value * 2])]);
+ * // Output: [1, 2, 2, 4, 3, 6]
+ * ```
+ */
+declare function flatMap<const ElementType, const MappedType>(iterable: IterableResolvable<ElementType>, callbackFn: (element: ElementType, index: number) => IterableResolvable<MappedType>): IterableIterator<MappedType>;
+
+export { flatMap };

package/dist/cjs/lib/forEach.cjs

@@ -0,0 +1,19 @@
+'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 forEach(iterable, callbackFn) {
+  callbackFn = _assertFunction_cjs.assertFunction(callbackFn);
+  let index = 0;
+  for (const element of toIterableIterator_cjs.toIterableIterator(iterable)) {
+    callbackFn(element, index++);
+  }
+}
+__name(forEach, "forEach");
+
+exports.forEach = forEach;
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=forEach.cjs.map

package/dist/cjs/lib/forEach.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/lib/forEach.ts"],"names":[],"mappings":";;;;AACA,SAAS,sBAAsB;AAC/B,SAAS,0BAA0B;AAqB5B,SAAS,QACf,UACA,YACO;AACP,eAAa,eAAe,UAAU;AAEtC,MAAI,QAAQ;AACZ,aAAW,WAAW,mBAAmB,QAAQ,GAAG;AACnD,eAAW,SAAS,OAAO;AAAA,EAC5B;AACD;AAVgB","sourcesContent":["import type { IterableResolvable } from './from';\nimport { assertFunction } from './shared/_assertFunction';\nimport { toIterableIterator } from './toIterableIterator';\n\n/**\n * Executes a provided function once for each iterable element.\n *\n * @param iterable An iterator to iterate over.\n * @param callbackFn A function to execute for each element produced by the iterator. Its return value is discarded.\n *\n * @example\n * ```typescript\n * import { forEach } from '@sapphire/iterator-utilities';\n *\n * const iterable = [1, 2, 3, 4, 5];\n * forEach(iterable, (value) => console.log(value));\n * // Output: 1, 2, 3, 4, 5\n * ```\n *\n * @remarks\n *\n * This function consumes the entire iterator.\n */\nexport function forEach<const ElementType>(\n\titerable: IterableResolvable<ElementType>,\n\tcallbackFn: (element: ElementType, index: number) => void\n): void {\n\tcallbackFn = assertFunction(callbackFn);\n\n\tlet index = 0;\n\tfor (const element of toIterableIterator(iterable)) {\n\t\tcallbackFn(element, index++);\n\t}\n}\n"]}

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

@@ -0,0 +1,24 @@
+import { IterableResolvable } from './from.cjs';
+
+/**
+ * Executes a provided function once for each iterable element.
+ *
+ * @param iterable An iterator to iterate over.
+ * @param callbackFn A function to execute for each element produced by the iterator. Its return value is discarded.
+ *
+ * @example
+ * ```typescript
+ * import { forEach } from '@sapphire/iterator-utilities';
+ *
+ * const iterable = [1, 2, 3, 4, 5];
+ * forEach(iterable, (value) => console.log(value));
+ * // Output: 1, 2, 3, 4, 5
+ * ```
+ *
+ * @remarks
+ *
+ * This function consumes the entire iterator.
+ */
+declare function forEach<const ElementType>(iterable: IterableResolvable<ElementType>, callbackFn: (element: ElementType, index: number) => void): void;
+
+export { forEach };

package/dist/cjs/lib/from.cjs

@@ -0,0 +1,25 @@
+'use strict';
+
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+
+// src/lib/from.ts
+function from(value) {
+  if (typeof value === "object" && value !== null) {
+    if (typeof value[Symbol.iterator] === "function") {
+      return value[Symbol.iterator]();
+    }
+    if (typeof value.next === "function") {
+      return value;
+    }
+  }
+  if (typeof value === "string") {
+    return value[Symbol.iterator]();
+  }
+  throw new TypeError(`${String(value)} cannot be converted to an iterable`);
+}
+__name(from, "from");
+
+exports.from = from;
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=from.cjs.map

package/dist/cjs/lib/from.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/lib/from.ts"],"names":[],"mappings":";;;;AAmBO,SAAS,KAAK,OAAY;AAChC,MAAI,OAAO,UAAU,YAAY,UAAU,MAAM;AAChD,QAAI,OAAO,MAAM,OAAO,QAAQ,MAAM,YAAY;AACjD,aAAO,MAAM,OAAO,QAAQ,EAAE;AAAA,IAC/B;AAEA,QAAI,OAAO,MAAM,SAAS,YAAY;AACrC,aAAO;AAAA,IACR;AAAA,EACD;AAEA,MAAI,OAAO,UAAU,UAAU;AAC9B,WAAO,MAAM,OAAO,QAAQ,EAAE;AAAA,EAC/B;AAEA,QAAM,IAAI,UAAU,GAAG,OAAO,KAAK,CAAC,qCAAqC;AAC1E;AAhBgB","sourcesContent":["/**\n * Resolves an iterable from an iterable or iterator-like object.\n *\n * @param value The value to convert to an iterator.\n *\n * @example\n * ```typescript\n * import { from } from '@sapphire/iterator-utilities';\n *\n * const iterable = from([1, 2, 3, 4, 5]);\n * for (const element of iterable) {\n * \tconsole.log(element);\n * \t// Output: 1, 2, 3, 4, 5\n * }\n * ```\n */\nexport function from<const ElementType, const ResolvableType extends IterableResolvable<ElementType>>(\n\tvalue: ResolvableType\n): IterableResolved<ResolvableType>;\nexport function from(value: any) {\n\tif (typeof value === 'object' && value !== null) {\n\t\tif (typeof value[Symbol.iterator] === 'function') {\n\t\t\treturn value[Symbol.iterator]();\n\t\t}\n\n\t\tif (typeof value.next === 'function') {\n\t\t\treturn value;\n\t\t}\n\t}\n\n\tif (typeof value === 'string') {\n\t\treturn value[Symbol.iterator]();\n\t}\n\n\tthrow new TypeError(`${String(value)} cannot be converted to an iterable`);\n}\n\nexport type IterableResolvable<ElementType> = Iterable<ElementType> | Iterator<ElementType> | IterableIterator<ElementType>;\n\nexport type IterableResolved<Type> =\n\tType extends IterableIterator<infer Output>\n\t\t? IterableIterator<Output>\n\t\t: Type extends Iterable<infer Output>\n\t\t\t? Iterator<Output>\n\t\t\t: Type extends Iterator<infer Output>\n\t\t\t\t? Iterator<Output>\n\t\t\t\t: never;\n"]}

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

@@ -0,0 +1,21 @@
+/**
+ * Resolves an iterable from an iterable or iterator-like object.
+ *
+ * @param value The value to convert to an iterator.
+ *
+ * @example
+ * ```typescript
+ * import { from } from '@sapphire/iterator-utilities';
+ *
+ * const iterable = from([1, 2, 3, 4, 5]);
+ * for (const element of iterable) {
+ * 	console.log(element);
+ * 	// Output: 1, 2, 3, 4, 5
+ * }
+ * ```
+ */
+declare function from<const ElementType, const ResolvableType extends IterableResolvable<ElementType>>(value: ResolvableType): IterableResolved<ResolvableType>;
+type IterableResolvable<ElementType> = Iterable<ElementType> | Iterator<ElementType> | IterableIterator<ElementType>;
+type IterableResolved<Type> = Type extends IterableIterator<infer Output> ? IterableIterator<Output> : Type extends Iterable<infer Output> ? Iterator<Output> : Type extends Iterator<infer Output> ? Iterator<Output> : never;
+
+export { type IterableResolvable, type IterableResolved, from };

package/dist/cjs/lib/indexOf.cjs

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

package/dist/cjs/lib/indexOf.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/lib/indexOf.ts"],"names":[],"mappings":";;;;AACA,SAAS,0BAA0B;AAsB5B,SAAS,QAA2B,UAA2C,OAA4B;AACjH,MAAI,QAAQ;AACZ,aAAW,WAAW,mBAAmB,QAAQ,GAAG;AACnD,QAAI,YAAY,OAAO;AACtB,aAAO;AAAA,IACR;AAEA;AAAA,EACD;AAEA,SAAO;AACR;AAXgB","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"]}

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

@@ -0,0 +1,25 @@
+import { IterableResolvable } from './from.cjs';
+
+/**
+ * Advances the iterable until it finds the element, returning its index if it's found and `-1` otherwise.
+ *
+ * @param iterable An iterator to search for a value in.
+ * @param value The value to search for.
+ * @returns The index of the first occurrence of the value in the iterator, or `-1` if the value is not found.
+ *
+ * @example
+ * ```typescript
+ * import { indexOf } from '@sapphire/iterator-utilities';
+ *
+ * const iterable = [1, 2, 3, 4, 5];
+ * console.log(indexOf(iterable, 3));
+ * // Output: 2
+ * ```
+ *
+ * @remarks
+ *
+ * This function consumes the iterator until the value is found or the iterator is exhausted.
+ */
+declare function indexOf<const ElementType>(iterable: IterableResolvable<ElementType>, value: ElementType): number;
+
+export { indexOf, indexOf as position };

package/dist/cjs/lib/intersect.cjs

@@ -0,0 +1,16 @@
+'use strict';
+
+var filter_cjs = require('./filter.cjs');
+var toIterableIterator_cjs = require('./toIterableIterator.cjs');
+
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+function intersect(first, second) {
+  const set = new Set(toIterableIterator_cjs.toIterableIterator(second));
+  return filter_cjs.filter(first, (value) => set.has(value));
+}
+__name(intersect, "intersect");
+
+exports.intersect = intersect;
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=intersect.cjs.map

package/dist/cjs/lib/intersect.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/lib/intersect.ts"],"names":[],"mappings":";;;;AAAA,SAAS,cAAc;AAEvB,SAAS,0BAA0B;AAuB5B,SAAS,UACf,OACA,QACgC;AAChC,QAAM,MAAM,IAAI,IAAI,mBAAmB,MAAM,CAAC;AAC9C,SAAO,OAAO,OAAO,CAAC,UAAU,IAAI,IAAI,KAAK,CAAC;AAC/C;AANgB","sourcesContent":["import { filter } from './filter';\nimport type { IterableResolvable } from './from';\nimport { toIterableIterator } from './toIterableIterator';\n\n/**\n * Creates an iterable with the elements that are in both input iterables.\n *\n * @param first An iterator to return elements from.\n * @param second An iterator that contains elements to include in the result.\n *\n * @example\n * ```typescript\n * import { intersect } from '@sapphire/iterator-utilities';\n *\n * const iterable = intersect([1, 2, 3, 4, 5], [3, 4, 5, 6, 7]);\n * console.log([...iterable]);\n * // Output: [3, 4, 5]\n * ```\n *\n * @remarks\n *\n * This function consumes the entire `second` iterator to build the set of elements to intersect with `first`.\n *\n * @seealso {@link difference} for the opposite behavior.\n */\nexport function intersect<const ElementType>(\n\tfirst: IterableResolvable<ElementType>,\n\tsecond: IterableResolvable<ElementType>\n): IterableIterator<ElementType> {\n\tconst set = new Set(toIterableIterator(second));\n\treturn filter(first, (value) => set.has(value));\n}\n"]}

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

@@ -0,0 +1,26 @@
+import { IterableResolvable } from './from.cjs';
+
+/**
+ * Creates an iterable with the elements that are in both input iterables.
+ *
+ * @param first An iterator to return elements from.
+ * @param second An iterator that contains elements to include in the result.
+ *
+ * @example
+ * ```typescript
+ * import { intersect } from '@sapphire/iterator-utilities';
+ *
+ * const iterable = intersect([1, 2, 3, 4, 5], [3, 4, 5, 6, 7]);
+ * console.log([...iterable]);
+ * // Output: [3, 4, 5]
+ * ```
+ *
+ * @remarks
+ *
+ * This function consumes the entire `second` iterator to build the set of elements to intersect with `first`.
+ *
+ * @seealso {@link difference} for the opposite behavior.
+ */
+declare function intersect<const ElementType>(first: IterableResolvable<ElementType>, second: IterableResolvable<ElementType>): IterableIterator<ElementType>;
+
+export { intersect };

package/dist/cjs/lib/isEmpty.cjs

@@ -0,0 +1,14 @@
+'use strict';
+
+var from_cjs = require('./from.cjs');
+
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+function isEmpty(iterable) {
+  return from_cjs.from(iterable).next().done ?? false;
+}
+__name(isEmpty, "isEmpty");
+
+exports.isEmpty = isEmpty;
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=isEmpty.cjs.map

package/dist/cjs/lib/isEmpty.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/lib/isEmpty.ts"],"names":[],"mappings":";;;;AAAA,SAAS,YAAqC;AAuBvC,SAAS,QAA2B,UAAoD;AAC9F,SAAO,KAAK,QAAQ,EAAE,KAAK,EAAE,QAAQ;AACtC;AAFgB","sourcesContent":["import { from, type IterableResolvable } from './from';\n\n/**\n * Advances the iterable once, returning `true` if it's exhausted and `false` otherwise.\n *\n * @param iterable The iterator to check for emptiness.\n * @returns `true` if the iterator is empty; otherwise, `false`.\n *\n * @example\n * ```typescript\n * import { isEmpty } from '@sapphire/iterator-utilities';\n *\n * console.log(isEmpty([]));\n * // Output: true\n *\n * console.log(isEmpty([1, 2, 3, 4, 5]));\n * // Output: false\n * ```\n *\n * @remarks\n *\n * This function consumes the first value of the iterator.\n */\nexport function isEmpty<const ElementType>(iterable: IterableResolvable<ElementType>): boolean {\n\treturn from(iterable).next().done ?? false;\n}\n"]}

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

@@ -0,0 +1,26 @@
+import { IterableResolvable } from './from.cjs';
+
+/**
+ * Advances the iterable once, returning `true` if it's exhausted and `false` otherwise.
+ *
+ * @param iterable The iterator to check for emptiness.
+ * @returns `true` if the iterator is empty; otherwise, `false`.
+ *
+ * @example
+ * ```typescript
+ * import { isEmpty } from '@sapphire/iterator-utilities';
+ *
+ * console.log(isEmpty([]));
+ * // Output: true
+ *
+ * console.log(isEmpty([1, 2, 3, 4, 5]));
+ * // Output: false
+ * ```
+ *
+ * @remarks
+ *
+ * This function consumes the first value of the iterator.
+ */
+declare function isEmpty<const ElementType>(iterable: IterableResolvable<ElementType>): boolean;
+
+export { isEmpty };

package/dist/cjs/lib/last.cjs

@@ -0,0 +1,18 @@
+'use strict';
+
+var toIterableIterator_cjs = require('./toIterableIterator.cjs');
+
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+function last(iterable) {
+  let last2;
+  for (const value of toIterableIterator_cjs.toIterableIterator(iterable)) {
+    last2 = value;
+  }
+  return last2;
+}
+__name(last, "last");
+
+exports.last = last;
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=last.cjs.map

package/dist/cjs/lib/last.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/lib/last.ts"],"names":["last"],"mappings":";;;;AACA,SAAS,0BAA0B;AAqB5B,SAAS,KAAwB,UAAoE;AAC3G,MAAIA;AACJ,aAAW,SAAS,mBAAmB,QAAQ,GAAG;AACjD,IAAAA,QAAO;AAAA,EACR;AAEA,SAAOA;AACR;AAPgB","sourcesContent":["import type { IterableResolvable } from './from';\nimport { toIterableIterator } from './toIterableIterator';\n\n/**\n * Consumes the iterable until it's exhausted, returning the last element.\n *\n * @param iterable An iterator to return the last value of.\n * @returns The value at the last position in the source iterator, or `undefined` if the iterator is empty.\n *\n * @example\n * ```typescript\n * import { last } from '@sapphire/iterator-utilities';\n *\n * const iterable = [1, 2, 3, 4, 5];\n * console.log(last(iterable));\n * // Output: 5\n * ```\n *\n * @remarks\n *\n * This function consumes the entire iterator to find the last value.\n */\nexport function last<const ElementType>(iterable: IterableResolvable<ElementType>): ElementType | undefined {\n\tlet last: ElementType | undefined;\n\tfor (const value of toIterableIterator(iterable)) {\n\t\tlast = value;\n\t}\n\n\treturn last;\n}\n"]}