Skip to main content

FluidIterable Interface

Like TypeScript's built-in Iterable 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 FluidIterable<T>

Type Parameters

ParameterDescription
T

Methods

MethodAlertsReturn TypeDescription
[Symbol.iterator]()BetaFluidIterableIterator<T>Returns an iterator over the elements in this iterable.

Method Details

[Symbol.iterator]

Returns an iterator over the elements in this iterable.

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

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

Signature

[Symbol.iterator](): FluidIterableIterator<T>;

Remarks

Works like the built-in \[Symbol.iterator\] protocol.

Returns

Return type: FluidIterableIterator<T>