DefinitelyTyped/types/tween.js/index.d.ts

// Type definitions for tween.js 17.2
// Project: https://github.com/tweenjs/tween.js/
// Definitions by: jordan <https://github.com/Amos47>, sunetos <https://github.com/sunetos>, jzarnikov <https://github.com/jzarnikov>, alexburner <https://github.com/alexburner>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

declare namespace TWEEN {
    export function getAll(): Tween[];
    export function removeAll(): void;
    export function add(tween: Tween): void;
    export function remove(tween: Tween): void;
    export function update(time?: number, preserve?: boolean): boolean;
    export function now(): number;

    export class Tween {
        constructor(object?: any, group?: Group);
        getId(): number;
        isPlaying(): boolean;
        to(properties: any, duration: number): Tween;
        start(time?: number): Tween;
        stop(): Tween;
        end(): Tween;
        stopChainedTweens(): Tween;
        group(group: Group): Tween;
        delay(amount: number): Tween;
        repeat(times: number): Tween;
        repeatDelay(times: number): Tween;
        yoyo(enable: boolean): Tween;
        easing(easing: (k: number) => number): Tween;
        interpolation(interpolation: (v: number[], k: number) => number): Tween;
        chain(...tweens: Tween[]): Tween;
        onStart(callback: (object?: any) => void): Tween;
        onStop(callback: (object?: any) => void): Tween;
        onUpdate(callback: (object?: any) => void): Tween;
        onComplete(callback: (object?: any) => void): Tween;
        update(time: number): boolean;
    }

    export class Group {
        constructor();
        getAll(): Tween[];
        removeAll(): void;
        add(tween: Tween): void;
        remove(tween: Tween): void;
        update(time?: number, preserve?: boolean): boolean;
    }

    export var Easing: Easing;
    export var Interpolation: Interpolation;
}

interface Easing {
    Linear: {
        None(k: number): number;
    };
    Quadratic: {
        In(k: number): number;
        Out(k: number): number;
        InOut(k: number): number;
    };
    Cubic: {
        In(k: number): number;
        Out(k: number): number;
        InOut(k: number): number;
    };
    Quartic: {
        In(k: number): number;
        Out(k: number): number;
        InOut(k: number): number;
    };
    Quintic: {
        In(k: number): number;
        Out(k: number): number;
        InOut(k: number): number;
    };
    Sinusoidal: {
        In(k: number): number;
        Out(k: number): number;
        InOut(k: number): number;
    };
    Exponential: {
        In(k: number): number;
        Out(k: number): number;
        InOut(k: number): number;
    };
    Circular: {
        In(k: number): number;
        Out(k: number): number;
        InOut(k: number): number;
    };
    Elastic: {
        In(k: number): number;
        Out(k: number): number;
        InOut(k: number): number;
    };
    Back: {
        In(k: number): number;
        Out(k: number): number;
        InOut(k: number): number;
    };
    Bounce: {
        In(k: number): number;
        Out(k: number): number;
        InOut(k: number): number;
    };
}

interface Interpolation {
    Linear(v: number[], k: number): number;
    Bezier(v: number[], k: number): number;
    CatmullRom(v: number[], k: number): number;

    Utils: {
        Linear(p0: number, p1: number, t: number): number;
        Bernstein(n: number, i: number): number;
        Factorial(n: number): number;
        CatmullRom(p0: number, p1: number, p2: number, p3: number, t: number): number;
    };
}

declare module "@tweenjs/tween.js" {
    export = TWEEN;
}