@types/roll-a-die NPM

Installation

npm install --save @types/roll-a-die

Summary

This package contains type definitions for roll-a-die (https://github.com/chukwumaijem/roll-a-die).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/roll-a-die.

index.d.ts

// Type definitions for roll-a-die 1.5
// Project: https://github.com/chukwumaijem/roll-a-die
// Definitions by: Romilo <https://github.com/romilodev>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

export interface Options {
    /** The element to render die animation on. */
    element: HTMLElement;
    /** The number of dice to use. */
    numberOfDice: number;
    /**
     * Called when animation is finished.
     * @param values An array of the values from throw.
     */
    callback: (values: number[]) => any;
    /**
     * Roll the die without sound.
     * @default false
     */
    noSound?: boolean | undefined;
    /**
     * Time in milliseconds to delay before removing animations
     * @default 3000
     */
    delay?: number | undefined;
    /**
     * Values to show on die face.
     * When provided, it overrides library genrated values.
     */
    values?: number[] | undefined;
  }

/**
 * Run 3D dice roll animation.
 *
 * @param options
 *
 * @example
 * rollADie({ element, numberOfDice: 2, callback});
 *
 * @example
 * rollADie({ element, numberOfDice: 2, callback, noSound: true});
 *
 * @example
 * rollADie({ element, numberOfDice: 2, callback, delay: 1000});
 *
 * @example
 * rollADie({ element, numberOfDice: 2, callback, values: [3, 4]});
 *
 * @see {@link https://github.com/chukwumaijem/roll-a-die|Github}
 * @see {@link https://www.npmjs.com/package/roll-a-die|NPM}
 * @see {@link https://codepen.io/chukwuma-ezumezu/pen/qYKOGW|Demo}
 */
export default function(options: Options): void;