@types/countdown

Installation

npm install --save @types/countdown

Summary

This package contains type definitions for countdown (http://countdownjs.org/).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/countdown.

index.d.ts

declare namespace countdown {
    type DateFunction = (timespan: Timespan) => void;
    type DateTime = number | Date | DateFunction | null | undefined;

    interface Timespan {
        start?: Date | undefined;
        end?: Date | undefined;
        units?: number | undefined;
        value?: number | undefined;
        millennia?: number | undefined;
        centuries?: number | undefined;
        decades?: number | undefined;
        years?: number | undefined;
        months?: number | undefined;
        weeks?: number | undefined;
        days?: number | undefined;
        hours?: number | undefined;
        minutes?: number | undefined;
        seconds?: number | undefined;
        milliseconds?: number | undefined;
        toString(label?: string): string;
        toHTML(tagName?: string, label?: string): string;
    }

    interface Format {
        singular?: string | string[] | undefined;
        plural?: string | string[] | undefined;
        last?: string | undefined;
        delim?: string | undefined;
        empty?: string | undefined;
        formatNumber?(value: number): string;
        formatter?(value: number, unit: number): string;
    }

    interface CountdownStatic {
        (start: DateTime, end?: DateTime, units?: number, max?: number, digits?: number): Timespan | number;
        MILLENNIA: number;
        CENTURIES: number;
        DECADES: number;
        YEARS: number;
        MONTHS: number;
        WEEKS: number;
        DAYS: number;
        HOURS: number;
        MINUTES: number;
        SECONDS: number;
        MILLISECONDS: number;
        ALL: number;
        DEFAULTS: number;
        resetLabels(): void;
        setLabels(
            singular?: string,
            plural?: string,
            last?: string,
            delim?: string,
            empty?: string,
            formatNumber?: (value: number) => string,
            formatter?: (value: number, unit: number) => string,
        ): void;
        resetFormat(): void;
        setFormat(format: Format): void;
    }
}

declare module "countdown" {
    let countdown: countdown.CountdownStatic;
    export = countdown;
}

Additional Details

• Last updated: Mon, 20 Nov 2023 23:36:24 GMT
• Dependencies: none

Credits

These definitions were written by Gabriel Juchault, and Ionaru.