dicewerx/dist/die.d.ts

Standard dice notation parser and evaluator, written in TypeScript

/**
 * An N sided die that is capable of producing a random number between 1 and N
 * @remarks
 * Has its number of sides set at creation and get rolled immediately.
 * Can be rerolled on demand
 */
export declare class Die {
    sides: number;
    result: number;
    constructor(sides: number);
    /**
     * Rolls the die and returns the result
     * @remarks
     * Returns a random number between 1 and sides
     * @returns A random number between 1 and sides
     */
    roll(): number;
}