@kizmann/pico-js 2.0.4 → 2.0.6

package/types/utils/Runner.d.ts

@@ -1,87 +1,73 @@
 export class PicoRunner {
-    static $idler: {
-        native: {};
-        debounce: {};
-        throttle: {};
-    };
-    static $timer: {
-        date: number;
-        func: any;
-    };
+    static $idler: any;
+    static $timer: number;
     static $buffer: any[];
     /**
-     * Run callback after delay (id)
+     * Clear timer or call function
      *
-     * @example Run.timeout(() => {}, 100) // => "t-..."
+     * @example Run.clear(timer)
      *
-     * @param {function} fn Callback to run
-     * @param {number} [delay] Delay ms
-     * @param {string|null} [index] Timer id
-     * @returns {string} Timer id
+     * @param {any} timer Timer ID, array of IDs, or function
+     * @returns {typeof PicoRunner} Static class
      */
-    static timeout(fn: Function, delay?: number, index?: string | null): string;
+    static clear(timer: any): typeof PicoRunner;
     /**
-     * Run callback on interval (id)
-     *
-     * @example Run.interval(() => {}, 250) // => "i-..."
+     * Request idle callback with fallback
      *
-     * @param {function} fn Callback to run
-     * @param {number} [intval] Interval ms
-     * @param {string|null} [index] Timer id
-     * @returns {string} Timer id
+     * @param {function} cb Callback function
+     * @returns {typeof PicoRunner} Static class
      */
-    static interval(fn: Function, intval?: number, index?: string | null): string;
+    static tryin(cb: Function): typeof PicoRunner;
     /**
-     * Clear timer(s) by id
+     * Wait for condition to be true
      *
-     * @example Run.clear("i-abc") // => Run
-     * @example Run.clear(["t-a","i-b"]) // => Run
+     * @example Run.wait(() => window.foo, 10, 100)
      *
-     * @param {string|Array<string>} index Timer id(s)
-     * @param {string} [scope] Idler scope key
-     * @returns {typeof PicoRunner} Runner class
+     * @param {function} fn Condition function
+     * @param {number} [intval] Interval ms
+     * @param {number} [limit] Max iterations
+     * @returns {function} Clear function
      */
-    static clear(index: string | Array<string>, scope?: string): typeof PicoRunner;
+    static wait(fn: Function, intval?: number, limit?: number): Function;
     /**
-     * Poll until callback is true
+     * Run function in next animation frame
      *
-     * @example Run.wait(() => ready, 50) // polls
+     * @example Run.frame(cb)
      *
-     * @param {function} fn Condition callback
-     * @param {number} [intval] Poll interval ms
-     * @param {number} [limit] Max poll count
-     * @returns {void} No return value
+     * @param {function} fn Callback function
+     * @param {any} [...args] Callback arguments
+     * @returns {function} Noop clear function
      */
-    static wait(fn: Function, intval?: number, limit?: number): void;
+    static frame(fn: Function, ...args: any[]): Function;
     /**
-     * Run callback in next frame
+     * Run function when browser is idle
      *
-     * @example Run.frame(() => {}) // => Run
+     * @example Run.idle(cb)
      *
-     * @param {function} fn Callback to run
-     * @param {...any} args Callback args
-     * @returns {typeof PicoRunner} Runner class
+     * @param {function} fn Callback function
+     * @param {any} [...args] Callback arguments
+     * @returns {function} Noop clear function
      */
-    static frame(fn: Function, ...args: any[]): typeof PicoRunner;
+    static idle(fn: Function, ...args: any[]): Function;
     /**
-     * Run callback async soon
+     * Run function asynchronously
      *
-     * @example Run.async(() => {}) // => Run
+     * @example Run.async(cb)
      *
-     * @param {function} fn Callback to run
-     * @param {...any} args Callback args
-     * @returns {typeof PicoRunner} Runner class
+     * @param {function} fn Callback function
+     * @param {any} [...args] Callback arguments
+     * @returns {function} Noop clear function
      */
-    static async(fn: Function, ...args: any[]): typeof PicoRunner;
+    static async(fn: Function, ...args: any[]): Function;
     /**
-     * Run callback after delay
+     * Run function after delay
      *
-     * @example const cancel = Run.delay(() => {}, 50)
+     * @example Run.delay(cb, 100)
      *
-     * @param {function} fn Callback to run
+     * @param {function} fn Callback function
      * @param {number} [delay] Delay ms
-     * @param {...any} args Callback args
-     * @returns {function} Cancel function
+     * @param {any} [...args] Callback arguments
+     * @returns {function} Clear function
      */
     static delay(fn: Function, delay?: number, ...args: any[]): Function;
     /**
@@ -91,10 +77,9 @@ export class PicoRunner {
      *
      * @param {function} cb Callback to run
      * @param {number} [timeout] Wait ms
-     * @param {string|null} [index] Debounce id
      * @returns {function} Debounced fn
      */
-    static debounce(cb: Function, timeout?: number, index?: string | null): Function;
+    static debounce(cb: Function, timeout?: number): Function;
     /**
      * Create throttled callback
      *
@@ -102,10 +87,9 @@ export class PicoRunner {
      *
      * @param {function} cb Callback to run
      * @param {number} [timeout] Wait ms
-     * @param {string|null} [index] Throttle id
      * @returns {function} Throttled fn
      */
-    static throttle(cb: Function, timeout?: number, index?: string | null): Function;
+    static throttle(cb: Function, timeout?: number): Function;
     /**
      * Create framerate-limited callback
      *
@@ -123,10 +107,10 @@ export class PicoRunner {
      *
      * @param {function} cb Callback to run
      * @param {string} key Buffer key
-     * @param {number} [order] Sort order
+     * @param {number} [priority] Sort priority
      * @returns {function} Buffered handler
      */
-    static framebuffer(cb: Function, key: string, order?: number): Function;
+    static framebuffer(cb: Function, key: string, priority?: number): Function;
     /**
      * Flush buffered frame events
      *