@tsonic/js-globals 0.2.3 → 0.3.1

package/index.d.ts

@@ -150,6 +150,11 @@ declare global {
      * Calls a defined callback function on each element of an array, and then flattens the result by one level.
      */
     flatMap<U>(callback: (value: T, index: int, array: T[]) => U | U[]): U[];
+
+    /**
+     * Returns an iterator over the array elements.
+     */
+    [Symbol.iterator](): IterableIterator<T>;
   }
 
   interface ReadonlyArray<T> {
@@ -170,6 +175,7 @@ declare global {
     concat(...items: (T | readonly T[])[]): T[];
     join(separator?: string): string;
     at(index: int): T | undefined;
+    [Symbol.iterator](): IterableIterator<T>;
   }
 
   interface ArrayConstructor {
@@ -570,17 +576,27 @@ declare global {
   /**
    * Iterator types
    */
-  interface Iterator<T> {
-    next(): IteratorResult<T>;
-    return?(value?: any): IteratorResult<T>;
-    throw?(e?: any): IteratorResult<T>;
+  interface Iterator<T, TReturn = any, TNext = undefined> {
+    next(...args: [] | [TNext]): IteratorResult<T, TReturn>;
+    return?(value?: TReturn): IteratorResult<T, TReturn>;
+    throw?(e?: any): IteratorResult<T, TReturn>;
   }
 
-  interface IteratorResult<T> {
+  interface IteratorResult<T, TReturn = any> {
     done: boolean;
+    value: T | TReturn;
+  }
+
+  interface IteratorYieldResult<T> {
+    done: false;
     value: T;
   }
 
+  interface IteratorReturnResult<TReturn> {
+    done: true;
+    value: TReturn;
+  }
+
   interface Iterable<T> {
     [Symbol.iterator](): Iterator<T>;
   }
@@ -589,6 +605,40 @@ declare global {
     [Symbol.iterator](): IterableIterator<T>;
   }
 
+  /**
+   * Async Iterator types (for for-await loops)
+   */
+  interface AsyncIterator<T, TReturn = any, TNext = undefined> {
+    next(...args: [] | [TNext]): Promise<IteratorResult<T, TReturn>>;
+    return?(value?: TReturn | PromiseLike<TReturn>): Promise<IteratorResult<T, TReturn>>;
+    throw?(e?: any): Promise<IteratorResult<T, TReturn>>;
+  }
+
+  interface AsyncIterable<T> {
+    [Symbol.asyncIterator](): AsyncIterator<T>;
+  }
+
+  interface AsyncIterableIterator<T> extends AsyncIterator<T> {
+    [Symbol.asyncIterator](): AsyncIterableIterator<T>;
+  }
+
+  /**
+   * Generator types
+   */
+  interface Generator<T = unknown, TReturn = any, TNext = unknown> extends Iterator<T, TReturn, TNext> {
+    next(...args: [] | [TNext]): IteratorResult<T, TReturn>;
+    return(value: TReturn): IteratorResult<T, TReturn>;
+    throw(e: any): IteratorResult<T, TReturn>;
+    [Symbol.iterator](): Generator<T, TReturn, TNext>;
+  }
+
+  interface AsyncGenerator<T = unknown, TReturn = any, TNext = unknown> extends AsyncIterator<T, TReturn, TNext> {
+    next(...args: [] | [TNext]): Promise<IteratorResult<T, TReturn>>;
+    return(value: TReturn | PromiseLike<TReturn>): Promise<IteratorResult<T, TReturn>>;
+    throw(e: any): Promise<IteratorResult<T, TReturn>>;
+    [Symbol.asyncIterator](): AsyncGenerator<T, TReturn, TNext>;
+  }
+
   /**
    * Template literal type utilities
    */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tsonic/js-globals",
-  "version": "0.2.3",
+  "version": "0.3.1",
   "description": "Global type definitions for Tsonic JS mode (noLib: true, JavaScript semantics)",
   "main": "index.d.ts",
   "types": "index.d.ts",