nice-timer/index.d.ts

Timer

import type {
  CreateOption,
  Option,
  TimerId,
  TimerOption,
  Handler,
  KeyType
} from './types/index';

/**
 * create 创建定时任务
 *
 * run 运行所有的定时任务
 *
 * stop 停止所有定时任务
 *
 * clear 停止并清理所有定时任务
 *
 * isAliveSymbolKey 是否存在该定时任务的标识符(建议使用symbol) true表示存在
 */
export declare class Timer {
  constructor(option?: Option);
  public option: Option;
  public create(option: CreateOption): () => void;
  public create(option: Handler, time?: number, loop?: boolean): () => void;
  public run(): void;
  public stop(): void;
  public clear(): void;
  public isAliveSymbolKey(key: KeyType): boolean;
  public wait(time: number): Promise<void>;
  private close(id: TimerId): void;
  private closeID: number | null;
  private timerMap: Map<TimerId, TimerOption>;
  private symbolKey: Map<KeyType, TimerId>;
  private stopState: boolean;
  private judge(option: CreateOption): boolean;
  private doSomeThing(): void;
  private closeTimer(): void;
}

/**
 * 默认Timer的实例
 */
export declare const TimerInstance: Timer;

/**
 * 创建定时任务后返回关闭函数
 */
export declare function timer(timerOption: CreateOption): () => void;
export declare function timer(
  timerOption: Handler,
  time?: number,
  loop?: boolean
): () => void;

/**
 * 等待
 */
export declare const wait: (time: number) => Promise<void>;

export default timer;