DefinitelyTyped/types/cycled/index.d.ts

// Type definitions for cycled 1.0
// Project: https://github.com/sindresorhus/cycled#readme
// Definitions by: BendingBender <https://github.com/BendingBender>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

export = Cycled;

// tslint:disable:jsdoc-format
declare class Cycled<T> extends Array<T> {
    /**
     * Initiates an array subclass with the methods documented below.
     * Since it's an array, you can use all the normal array methods on it.
     *
     * The instance is an iterable that will cycle through the array.
     * It will cycle through the number of elements equaling the length of the array from the current index.
     * ```
const numberCycle = new Cycled([1,2,3,4,5]);

console.log(...numberCycle);
//=> 1 2 3 4 5
```
     *
     * @param input
     */
    constructor(input: T[]);

    /**
     * Get or set the current index.
     */
    index: number;

    /**
     * Returns the current item.
     */
    current(): T;
    /**
     * Returns the next item.
     */
    next(): T;
    /**
     * Returns the previous item.
     */
    previous(): T;
    /**
     * Returns the item by going the given amount of `steps` through the array.
     * For example, calling `step(2)` is like calling `next()` twice. You go backward by specifying a negative number.
     * @param steps
     */
    step(steps: number): T;
    /**
     * Returns an iterable that will cycle through the array indefinitely.
     */
    indefinitely(): Iterator<T>;
    /**
     * Returns an iterable that will cycle through the array backward indefinitely.
     */
    indefinitelyReversed(): Iterator<T>;
}