Skip to content

Build your own AI office with Univer Office SDK. Bring editing, calculation, collaboration, and file processing into your product for people and AI agents. Built on an extensible open-source core.

1.7 KB
Raw Blame
/**
 * Copyright 2023-present DreamNum Co., Ltd.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * Returns a Promise that resolves after the specified number of milliseconds.
 * Use this to pause execution for a given duration.
 *
 * @param ms The number of milliseconds to wait before resolving.
 * @returns A Promise that resolves after `ms` milliseconds.
 */
export function awaitTime(ms: number): Promise<void> {
    return new Promise((resolve) => setTimeout(resolve, ms));
}

/**
 * Returns a Promise that resolves after the specified number of animation frames.
 * Use this to wait for the browser to complete one or more rendering cycles.
 *
 * @param frames The number of animation frames to wait before resolving. Defaults to `1`.
 * @returns A Promise that resolves after `frames` animation frames.
 */
export function delayAnimationFrame(frames: number = 1): Promise<void> {
    return new Promise((resolve) => {
        let count = 0;

        const callback = () => {
            count++;
            if (count >= frames) {
                resolve();
            } else {
                requestAnimationFrame(callback);
            }
        };

        requestAnimationFrame(callback);
    });
}