@ckeditor/ckeditor5-utils
Version:
Miscellaneous utilities used by CKEditor 5.
20 lines (19 loc) • 720 B
TypeScript
/**
* @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
*/
/**
* @module utils/delay
*/
/**
* Returns a function wrapper that will trigger a function after a specified wait time.
* The timeout can be canceled by calling the cancel function on the returned wrapped function.
*
* @param func The function to wrap.
* @param wait The timeout in ms.
*/
export default function delay<T extends (...args: Array<any>) => any>(func: T, wait: number): DelayedFunc<T>;
export interface DelayedFunc<T extends (...args: Array<any>) => any> {
(...args: Parameters<T>): void;
cancel(): void;
}