@sapphire/iterator-utilities 2.0.2-next.bc456c31 → 2.1.0-next.038daf1c

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

@@ -0,0 +1,21 @@
+import { IterableResolvable } from './from.mjs';
+
+/**
+ * Creates an iterable with arrays of `count` elements representing a sliding window.
+ *
+ * @param iterable The iterator to take values from.
+ * @param count The maximum number of values in the window.
+ * @returns An iterator that yields windows with `count` values from the provided iterator.
+ *
+ * @example
+ * ```typescript
+ * import { windows } from '@sapphire/iterator-utilities';
+ *
+ * const iterable = [1, 2, 3, 4, 5];
+ * console.log([...windows(iterable, 2)]);
+ * // Output: [[1, 2], [2, 3], [3, 4], [4, 5]]
+ * ```
+ */
+declare function windows<const ElementType>(iterable: IterableResolvable<ElementType>, count: number): IterableIterator<ElementType[]>;
+
+export { windows };

package/dist/esm/lib/windows.mjs

@@ -0,0 +1,26 @@
+import { __name } from '../chunk-PAWJFY3S.mjs';
+import { from } from './from.mjs';
+import { assertPositive } from './shared/_assertPositive.mjs';
+import { makeIterableIterator } from './shared/_makeIterableIterator.mjs';
+import { toIntegerOrInfinityOrThrow } from './shared/_toIntegerOrInfinityOrThrow.mjs';
+
+function windows(iterable, count) {
+  count = assertPositive(toIntegerOrInfinityOrThrow(count), count);
+  const buffer = [];
+  const resolvedIterable = from(iterable);
+  return makeIterableIterator(() => {
+    while (buffer.length !== count) {
+      const result = resolvedIterable.next();
+      if (result.done) return { done: true, value: void 0 };
+      buffer.push(result.value);
+    }
+    const value = buffer.slice();
+    buffer.shift();
+    return { done: false, value };
+  });
+}
+__name(windows, "windows");
+
+export { windows };
+//# sourceMappingURL=windows.mjs.map
+//# sourceMappingURL=windows.mjs.map

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

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/lib/windows.ts"],"names":[],"mappings":";;;;;;AAqBO,SAAS,OAAA,CAA2B,UAA2C,KAAgD,EAAA;AACrI,EAAA,KAAA,GAAQ,cAAe,CAAA,0BAAA,CAA2B,KAAK,CAAA,EAAG,KAAK,CAAA;AAE/D,EAAA,MAAM,SAAS,EAAC;AAChB,EAAM,MAAA,gBAAA,GAAmB,KAAK,QAAQ,CAAA;AACtC,EAAA,OAAO,qBAAoC,MAAM;AAChD,IAAO,OAAA,MAAA,CAAO,WAAW,KAAO,EAAA;AAC/B,MAAM,MAAA,MAAA,GAAS,iBAAiB,IAAK,EAAA;AACrC,MAAA,IAAI,OAAO,IAAM,EAAA,OAAO,EAAE,IAAM,EAAA,IAAA,EAAM,OAAO,MAAU,EAAA;AAEvD,MAAO,MAAA,CAAA,IAAA,CAAK,OAAO,KAAK,CAAA;AAAA;AAGzB,IAAM,MAAA,KAAA,GAAQ,OAAO,KAAM,EAAA;AAC3B,IAAA,MAAA,CAAO,KAAM,EAAA;AACb,IAAO,OAAA,EAAE,IAAM,EAAA,KAAA,EAAO,KAAM,EAAA;AAAA,GAC5B,CAAA;AACF;AAjBgB,MAAA,CAAA,OAAA,EAAA,SAAA,CAAA","file":"windows.mjs","sourcesContent":["import { from, type IterableResolvable } from './from';\nimport { assertPositive } from './shared/_assertPositive';\nimport { makeIterableIterator } from './shared/_makeIterableIterator';\nimport { toIntegerOrInfinityOrThrow } from './shared/_toIntegerOrInfinityOrThrow';\n\n/**\n * Creates an iterable with arrays of `count` elements representing a sliding window.\n *\n * @param iterable The iterator to take values from.\n * @param count The maximum number of values in the window.\n * @returns An iterator that yields windows with `count` values from the provided iterator.\n *\n * @example\n * ```typescript\n * import { windows } from '@sapphire/iterator-utilities';\n *\n * const iterable = [1, 2, 3, 4, 5];\n * console.log([...windows(iterable, 2)]);\n * // Output: [[1, 2], [2, 3], [3, 4], [4, 5]]\n * ```\n */\nexport function windows<const ElementType>(iterable: IterableResolvable<ElementType>, count: number): IterableIterator<ElementType[]> {\n\tcount = assertPositive(toIntegerOrInfinityOrThrow(count), count);\n\n\tconst buffer = [] as ElementType[];\n\tconst resolvedIterable = from(iterable);\n\treturn makeIterableIterator<ElementType[]>(() => {\n\t\twhile (buffer.length !== count) {\n\t\t\tconst result = resolvedIterable.next();\n\t\t\tif (result.done) return { done: true, value: undefined };\n\n\t\t\tbuffer.push(result.value);\n\t\t}\n\n\t\tconst value = buffer.slice();\n\t\tbuffer.shift();\n\t\treturn { done: false, value };\n\t});\n}\n"]}

package/dist/iife/index.global.js

@@ -1030,6 +1030,24 @@ var SapphireIteratorUtilities = (function (exports) {
   }
   __name(unzip, "unzip");
 
+  // src/lib/windows.ts
+  function windows(iterable, count2) {
+    count2 = assertPositive(toIntegerOrInfinityOrThrow(count2), count2);
+    const buffer = [];
+    const resolvedIterable = from(iterable);
+    return makeIterableIterator(() => {
+      while (buffer.length !== count2) {
+        const result = resolvedIterable.next();
+        if (result.done) return { done: true, value: void 0 };
+        buffer.push(result.value);
+      }
+      const value = buffer.slice();
+      buffer.shift();
+      return { done: false, value };
+    });
+  }
+  __name(windows, "windows");
+
   // src/lib/zip.ts
   function* zip(...iterables) {
     const resolvedIterables = iterables.map((iterable) => from(iterable));
@@ -1143,6 +1161,7 @@ var SapphireIteratorUtilities = (function (exports) {
   exports.union = union;
   exports.unique = unique;
   exports.unzip = unzip;
+  exports.windows = windows;
   exports.zip = zip;
 
   return exports;