r3bl-ts-utils/build/timer-utils/index.d.ts

The `r3bl-ts-utils` package is a set of useful TypeScript functions and classes that can be used in Node.js and browser environments. They are inspired by Kotlin stdlib, and Rust to write code as expressions rather than statements, colorized text, powerfu

import { Counter } from "./counter";
import { Timer } from "./externals";
export * from "./counter";
export * from "./externals";
/**
 * timer-utils is a module that exposes very little to the users of this module by defining a clear
 * boundary between external and internal facing code.
 *
 * The trick that `index.ts` inside the timer-utils folder only exposes symbols that are defined
 * in `externals.ts`. The factory function `createTimer()` eliminates the need to access the
 * internal implementation `TimerImpl` class by any external code.
 *
 * On the other side (code using this library) the folder itself is imported, not a specific
 * file, using `import * as timer from "./timer-utils"`. Here, `timer-utils` is a folder,
 * and not a file.
 *
 * Internal
 * --------
 * For code inside this module, everything is openly exposed and is considered internal. Inside the
 * module, there are no protections in place. Here are the files that are internal only.
 *
 * 1. internals.ts      <- Internal interfaces, types
 * 2. timer-reducer.ts  <- Internal functions, interfaces, types
 * 3. timer-impl.ts     <- Internal classes, interfaces, functions
 *
 * External
 * --------
 * For users of this module, who don't care about the internal details of this module (and they
 * shouldn't have to), the main file is `externals.ts`. This following symbols are
 * exported by `index.ts`.
 *
 * 0. index.ts         <- Re-export all the external symbols (and factory function)
 * 1. counter.ts       <- External class
 * 2. timer-impl.ts    <- External class
 * 3. externals.ts     <- External interfaces, types
 */
/** Factory function to create an object that implements (external) Timer interface. */
export declare const createTimer: (name: string, delay: number, duration?: number | undefined, counter?: Counter | undefined) => Timer;
export declare class TimerRegistry {
    private static readonly timers;
    static killAll: () => void;
    private static killIfRunning;
    static add: (timer: Timer) => number;
}