@phosphor/algorithm/lib/retro.d.ts

PhosphorJS - Algorithms and Iterators

import { IIterator } from './iter';
/**
 * An object which can produce a reverse iterator over its values.
 */
export interface IRetroable<T> {
    /**
     * Get a reverse iterator over the object's values.
     *
     * @returns An iterator which yields the object's values in reverse.
     */
    retro(): IIterator<T>;
}
/**
 * A type alias for a retroable or builtin array-like object.
 */
export declare type RetroableOrArrayLike<T> = IRetroable<T> | ArrayLike<T>;
/**
 * Create an iterator for a retroable object.
 *
 * @param object - The retroable or array-like object of interest.
 *
 * @returns An iterator which traverses the object's values in reverse.
 *
 * #### Example
 * ```typescript
 * import { retro, toArray } from '@phosphor/algorithm';
 *
 * let data = [1, 2, 3, 4, 5, 6];
 *
 * let stream = retro(data);
 *
 * toArray(stream);  // [6, 5, 4, 3, 2, 1]
 * ```
 */
export declare function retro<T>(object: RetroableOrArrayLike<T>): IIterator<T>;
/**
 * An iterator which traverses an array-like object in reverse.
 *
 * #### Notes
 * This iterator can be used for any builtin JS array-like object.
 */
export declare class RetroArrayIterator<T> implements IIterator<T> {
    /**
     * Construct a new retro iterator.
     *
     * @param source - The array-like object of interest.
     */
    constructor(source: ArrayLike<T>);
    /**
     * Get an iterator over the object's values.
     *
     * @returns An iterator which yields the object's values.
     */
    iter(): IIterator<T>;
    /**
     * Create an independent clone of the iterator.
     *
     * @returns A new independent clone of the iterator.
     */
    clone(): IIterator<T>;
    /**
     * Get the next value from the iterator.
     *
     * @returns The next value from the iterator, or `undefined`.
     */
    next(): T | undefined;
    private _index;
    private _source;
}