@types/ember-task-scheduler

Installation

npm install --save @types/ember-task-scheduler

Summary

This package contains type definitions for ember-task-scheduler (https://github.com/BBVAEngineering/ember-task-scheduler).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember-task-scheduler.

index.d.ts

import Service from "@ember/service";

export function scheduleFrame(context: object, method: string): number;

export function exec(
    target: object,
    // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
    method: () => void | string,
    args: unknown[],
    onError: (e: Error, stack: object) => void,
    stack: object,
): void;

export function _logWarn(title: string, stack: object, test: boolean, options: object): void;

export default interface Scheduler extends Service {
    /**
     * Proxy to app environment configuration.
     */
    config: object;

    /**
     * Setup number of frames per second.
     */
    FPS: number;

    /**
     * On error hook executed when a task fails.
     */
    onError: ((error: Error) => void) | undefined;

    /**
     * Computed value of milliseconds per frame of current FPS configuration.
     */
    millisecondsPerFrame: number;

    /**
     * Initializes array of tasks.
     */
    init(): void;

    /**
     * Return when has pending tasks.
     */
    hasPendingTasks(): boolean;

    /**
     * Schedules a task into the scheduler.
     *
     * When first argument is a function it ignores the rest.
     */
    schedule<T, F extends (this: T, ...args: unknown[]) => void>(target: T, method: F, ...args: Parameters<F>): void;

    /**
     * Schedule a unique task into the scheduler.
     *
     * When first argument is a function it ignores the rest.
     */
    scheduleOnce<T, F extends (this: T, ...args: unknown[]) => void>(
        target: T,
        method: F,
        ...args: Parameters<F>
    ): void;

    /**
     * Try to cancel a given task.
     *
     * When first argument is a function it ignores the rest.
     */
    cancel<T, F extends (this: T, ...args: unknown[]) => null | unknown[]>(
        target: T,
        method: F,
        ...args: Parameters<F>
    ): null | unknown[];
}

Additional Details

• Last updated: Wed, 22 Nov 2023 00:24:48 GMT
• Dependencies: @types/ember__service

Credits

These definitions were written by golovkoe.