es-stl - v3.0.2
    Preparing search index...

    Interface IteratorOwner<V, K>

    Object that can be traversed by Iterator.

    Implement this interface when a collection wants to use the shared Iterator helpers without extending the base collection class.

    interface IteratorOwner<V, K = number> {
        traverse(
            breakFlag: boolean,
            reverse: boolean,
            callback: IterateCallback<V, K>,
        ): boolean;
    }

    Type Parameters

    • V

      Value type yielded by the owner.

    • K = number

      Key type yielded with each value.

    Implemented by

    Index

    Methods

    traverse

    Methods

    • Visits values owned by the object.

      Parameters

      • breakFlag: boolean

        Callback result that should stop traversal early.

      • reverse: boolean

        Whether traversal should run in reverse order.

      • callback: IterateCallback<V, K>

        Callback invoked for each value.

      Returns boolean

      breakFlag when traversal stops early, otherwise !breakFlag.

      The owner controls traversal order. Return breakFlag when traversal stops early; otherwise return !breakFlag after all values are visited.

    Settings

    Member Visibility

    On This Page

    Methods