Added more typings.

Author: uhop

src/FrameQueue.d.ts

@@ -0,0 +1,41 @@
+import {ListQueue, Task} from './ListQueue';
+
+/**
+ * A queue based on [requestAnimationFrame()](https://developer.mozilla.org/en-US/docs/Web/API/Window/requestAnimationFrame).
+ * Used in an animation loop or for drawing updates.
+ */
+export declare class FrameQueue extends ListQueue {
+  /**
+   * The batch size in milliseconds for running tasks.
+   * If `undefined`, all tasks are run in a single frame.
+   */
+  batch: number | undefined;
+
+  /**
+   * Creates a new frame queue.
+   * @param paused Whether the queue is starting paused.
+   * @param batchInMs The batch size in milliseconds.
+   */
+  constructor(paused: boolean = false, batchInMs?: number);
+
+  /**
+   * Enqueues a task.
+   * @param fn The function to execute.
+   * @returns The task object.
+   */
+  enqueue(fn: (timeStamp: number, task: Task, queue: FrameQueue) => void): Task;
+
+  /**
+   * Starts the queue.
+   * It is used internally by `resume()`.
+   * @returns The function that stops the queue.
+   */
+  startQueue(): (() => void) | null;
+}
+
+/**
+ * The default frame queue usually used as a global queue.
+ */
+export const frameQueue: FrameQueue;
+
+export default FrameQueue;

src/FrameQueue.js

@@ -1,3 +1,5 @@
+// @ts-self-types="./FrameQueue.d.ts"
+
 'use strict';
 
 import List from 'list-toolkit/list.js';

src/IdleQueue.d.ts

@@ -0,0 +1,53 @@
+import {ListQueue, Task} from './ListQueue';
+
+/**
+ * A queue based on [requestIdleCallback()](https://developer.mozilla.org/en-US/docs/Web/API/Window/requestIdleCallback).
+ * Used for background tasks.
+ */
+export declare class IdleQueue extends ListQueue {
+  /**
+   * The timeout batch size in milliseconds for running tasks.
+   * If `undefined`, all tasks are run in a single idle period.
+   * This timeout is used only when `deadline.didTimeout` passed by `requestIdleCallback()` is `true`.
+   */
+  timeoutBatch: number | undefined;
+
+  /**
+   * The options passed to `requestIdleCallback()`.
+   */
+  options: IdleCallbackOptions | undefined;
+
+  /**
+   * Creates a new idle queue.
+   * @param paused Whether the queue is starting paused.
+   * @param timeoutBatchInMs The timeout batch size in milliseconds.
+   * @param options The options passed to `requestIdleCallback()`.
+   */
+  constructor(paused: boolean = false, timeoutBatchInMs?: number, options?: IdleCallbackOptions);
+
+  /**
+   * Enqueues a task.
+   * @param fn The function to execute.
+   * @returns The task object.
+   */
+  enqueue(fn: (deadline: IdleDeadline, task: Task, queue: IdleQueue) => void): Task;
+
+  /**
+   * Starts the queue.
+   * It is used internally by `resume()`.
+   * @returns The function that stops the queue.
+   */
+  startQueue(): (() => void) | null;
+}
+
+/**
+ * The default idle queue usually used as a global queue.
+ */
+export const idleQueue: IdleQueue;
+
+/**
+ * A function that schedules a task to run in the next idle period.
+ */
+export const defer: (fn: (deadline: IdleDeadline, task: Task, queue: IdleQueue) => void) => Task;
+
+export default IdleQueue;

src/IdleQueue.js

@@ -1,3 +1,5 @@
+// @ts-self-types="./IdleQueue.d.ts"
+
 'use strict';
 
 import List from 'list-toolkit/list.js';

src/ListQueue.d.ts

@@ -0,0 +1,77 @@
+import {MicroTask} from './MicroTask';
+import {List} from 'list-toolkit';
+
+/**
+ * A list-based queue of microtasks that will be executed when scheduled.
+ * It is a base class for other list-based task queues.
+ */
+export declare class ListQueue extends MicroTaskQueue {
+  /**
+   * The list of tasks.
+   */
+  list: List<MicroTask>;
+
+  /**
+   * The function that stops the queue.
+   * It is used internally by `pause()` and `resume()`.
+   */
+  stopQueue: (() => void) | null;
+
+  /**
+   * Creates a new list queue.
+   * @param paused Whether the queue is starting paused.
+   */
+  constructor(paused: boolean);
+
+  /**
+   * Whether the queue is empty.
+   */
+  get isEmpty(): boolean;
+
+  /**
+   * Enqueues a microtask.
+   * @param fn The function to execute when the microtask is scheduled.
+   * @returns The enqueued microtask.
+   */
+  enqueue(fn: () => void): MicroTask;
+
+  /**
+   * Dequeues a microtask.
+   * @param task The microtask to dequeue.
+   * @returns The queue.
+   */
+  dequeue(task: MicroTask): ListQueue;
+
+  /**
+   * Clears the queue.
+   * @returns The queue.
+   */
+  clear(): ListQueue;
+
+  /**
+   * Pauses the queue.
+   * @returns The queue.
+   */
+  pause(): ListQueue;
+
+  /**
+   * Resumes the queue.
+   * @returns The queue.
+   */
+  resume(): ListQueue;
+
+  /**
+   * Starts the queue.
+   * It is used internally by `resume()`.
+   * It is meant to be overridden in subclasses.
+   * @returns The function that stops the queue.
+   */
+  startQueue(): (() => void) | null;
+}
+
+/**
+ * A task for list queues.
+ */
+export declare type Task = MicroTask;
+
+export default ListQueue;

src/ListQueue.js

@@ -1,3 +1,5 @@
+// @ts-self-types="./ListQueue.d.ts"
+
 'use strict';
 
 import List from 'list-toolkit/list.js';

src/MicroTask.d.ts

@@ -0,0 +1,17 @@
+/**
+ * A microtask that will be executed when scheduled.
+ */
+export declare class MicroTask {
+  /**
+   * The function to execute when the microtask is scheduled.
+   */
+  fn: () => void;
+
+  /**
+   * Creates a new microtask.
+   * @param fn The function to execute when the microtask is scheduled.
+   */
+  constructor(fn: () => void);
+}
+
+export default MicroTask;

src/MicroTask.js

@@ -1,3 +1,5 @@
+// @ts-self-types="./MicroTask.d.ts"
+
 'use strict';
 
 export class MicroTask {

src/MicroTaskQueue.d.ts

@@ -0,0 +1,63 @@
+import {MicroTask} from './MicroTask';
+
+/**
+ * A queue of microtasks that will be executed when scheduled.
+ * It is a base class for other task queues.
+ */
+export declare class MicroTaskQueue {
+  /**
+   * Whether the queue is paused.
+   */
+  paused: boolean;
+
+  /**
+   * Creates a new microtask queue.
+   * @param paused Whether the queue is paused.
+   */
+  constructor(paused: boolean);
+
+  /**
+   * Whether the queue is empty.
+   * It is meant to be overridden in subclasses.
+   */
+  get isEmpty(): boolean;
+
+  /**
+   * Enqueues a microtask.
+   * It is meant to be overridden in subclasses.
+   * @param fn The function to execute when the microtask is scheduled.
+   * @returns The enqueued microtask.
+   */
+  enqueue(fn: () => void): MicroTask;
+
+  /**
+   * Dequeues a microtask.
+   * It is meant to be overridden in subclasses.
+   * @param task The microtask to dequeue.
+   * @returns The queue.
+   */
+  dequeue(task: MicroTask): MicroTaskQueue;
+
+  /**
+   * Clears the queue.
+   * It is meant to be overridden in subclasses.
+   * @returns The queue.
+   */
+  clear(): MicroTaskQueue;
+
+  /**
+   * Pauses the queue.
+   * It is meant to be overridden in subclasses.
+   * @returns The queue.
+   */
+  pause(): MicroTaskQueue;
+
+  /**
+   * Resumes the queue.
+   * It is meant to be overridden in subclasses.
+   * @returns The queue.
+   */
+  resume(): MicroTaskQueue;
+}
+
+export default MicroTaskQueue;

src/MicroTaskQueue.js

@@ -1,3 +1,5 @@
+// @ts-self-types="./MicroTaskQueue.d.ts"
+
 'use strict';
 
 import MicroTask from './MicroTask.js';