graphdb/lib/util/iterable.d.ts

Javascript client library supporting GraphDB and RDF4J REST API.

export = Iterable;
/**
 * Utility class allowing to iterate a collection.
 *
 * Note: This should be used with immutable collections, e.g no add or remove
 * operations should be performed while iterating.
 *
 * @class
 * @author Mihail Radkov
 * @author Svilen Velikov
 */
declare class Iterable {
    /**
     * Constructs new iterable for the provided collection.
     *
     * @param {Object[]} iterable the collection to iterate
     */
    constructor(iterable: any[]);
    iterable: any[];
    index: number;
    size: number;
    /**
     * Returns if there are elements left to be iterated from the collection.
     *
     * Use this method before calling {@link next()} to avoid out of bounds error.
     *
     * @return {boolean} <code>true</code> if there is at least single element
     *                    left to iterate or <code>false</code> otherwise
     */
    hasNext(): boolean;
    /**
     * Returns the next object from the iterable collection.
     *
     * Before invoking this method, check if there are elements to iterate by
     * using {@link hasNext()} because if there are no objects left to iterate,
     * the function will blow with an error.
     *
     * @return {Object} the next iterated object from the collection
     * @throws {Error} if there are no more elements to be iterated
     */
    next(): any;
    /**
     * Resets the iterable to begin from the start as if it was just constructed.
     *
     * @return {Iterable} the current iterable for method chaining.
     */
    reset(): Iterable;
}