jodit/esm/types/async.d.ts

Jodit is an awesome and useful wysiwyg editor with filebrowser

/*!
 * Jodit Editor (https://xdsoft.net/jodit/)
 * Released under MIT see LICENSE.txt in the project root for license information.
 * Copyright (c) 2013-2025 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
 */
/**
 * @module types
 */
import type { CallbackFunction, IDestructible } from "./types";
import { Nullable } from "./types";
export type ITimeout = number | (() => number);
export interface IAsyncParams {
    timeout?: number;
    label?: string;
    promisify?: boolean;
}
interface RejectablePromise<T> extends Promise<T> {
    rejectCallback: (reason?: any) => void;
    finally(onfinally?: (() => void) | undefined | null): Promise<T>;
}
export interface IAsync extends IDestructible {
    delay(timeout: number | IAsyncParams): Promise<void>;
    setTimeout<T = any>(callback: (...args: T[]) => void, timeout: number | IAsyncParams, ...args: T[]): number;
    updateTimeout(label: string, timeout: number): Nullable<number>;
    clearTimeout(timer: number): void;
    clearTimeout(label: string): void;
    clearTimeout(timerOrLabel: number | string): void;
    clear(): void;
    promise<T>(executor: (resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void) => void): RejectablePromise<T>;
    promiseState(p: Promise<any>): Promise<'pending' | 'fulfilled' | 'rejected'>;
    debounce(fn: CallbackFunction, timeout: ITimeout | IAsyncParams, firstCallImmediately?: boolean): CallbackFunction;
    microDebounce<T extends CallbackFunction>(fn: T, firstCallImmediately?: boolean): T;
    throttle(fn: CallbackFunction, timeout: ITimeout | IAsyncParams, firstCallImmediately?: boolean): CallbackFunction;
    requestIdleCallback(fn: IdleRequestCallback, options?: {
        timeout: number;
    }): number;
    requestIdlePromise(options?: {
        timeout: number;
    }): RejectablePromise<number>;
    cancelIdleCallback(request: number): void;
    schedulerPostTask<T = void>(task: () => T, options: {
        delay?: number;
        priority?: 'background' | 'user-blocking' | 'user-visible';
        signal?: AbortSignal;
    }): Promise<T>;
    schedulerYield(): Promise<void>;
    /**
     * Smart wrapper for `requestAnimationFrame`
     */
    requestAnimationFrame(callback: FrameRequestCallback): number;
    /**
     * Smart wrapper for `cancelAnimationFrame`
     */
    cancelAnimationFrame(request: number): void;
}