Skip to main content

FluidIterableIterator Interface

Like TypeScript's built-in iterable iterator type.

This API is provided as a beta preview and may change without notice.

To use, import via fluid-framework/beta.

For more information about our API support guarantees, see here.

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

Signature​

/** @sealed */
export interface FluidIterableIterator<T> extends FluidIterable<T>

Extends: FluidIterable<T>

Type Parameters​

ParameterDescription
T

Methods​

MethodAlertsReturn TypeDescription
next()Beta{ value: T; done?: false; } | { value: any; done: true; }Returns the next element in the iteration sequence.

Method Details​

next​

Returns the next element in the iteration sequence.

This API is provided as a beta preview and may change without notice.

For more information about our API support guarantees, see here.

Signature​

next(): {
        value: T;
        done?: false;
    } | {
        value: any;
        done: true;
    };

Remarks​

Works like the built-in Iterator.next method. When there are remaining elements, returns \{ value: T; done?: false \}. When the iteration is complete, returns \{ value: any; done: true \}.

Returns​

Return type: { value: T; done?: false; } | { value: any; done: true; }