@types/scrambo

Installation

npm install --save @types/scrambo

Summary

This package contains type definitions for scrambo (https://github.com/nickcolley/scrambo).

Details

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

index.d.ts

type NNN = "222" | "333" | "444" | "555" | "666" | "777";
type ScrambleType = NNN | "clock" | "minx" | "pyram" | "sq1" | "skewb";

declare class Scrambo {
    /**
     * Sets this instance's scrambler type and returns the original instance.
     * @param type
     */
    type(type: ScrambleType): Scrambo;

    /**
     * Returns the currently configured scrambler type.
     */
    type(): ScrambleType;

    /**
     * Sets this instance's seed and returns the original instance.
     * @param seed
     */
    seed(seed: number): Scrambo;

    /**
     * Returns the current seed type of this scrambler.
     */
    seed(): number;

    /**
     * Sets this instance's scramble length and returns the original instance.
     * @param length
     */
    length(length: number): Scrambo;

    /**
     * Returns the currently configured scramble length.
     */
    length(): number;

    /**
     * Returns an array of random scrambles with the given length
     * for the configured scrambler type.
     * @param number defaults to 1
     */
    get(number?: number): [string];
}

export = Scrambo;

Additional Details

• Last updated: Tue, 07 Nov 2023 15:11:36 GMT
• Dependencies: none

Credits

These definitions were written by Christopher Mühl.