Class: ValueIterable

hyrrokkin_engine.ValueIterable()

Implement an async iterable of values with some added functionality. Call hyrrokkin_engine.ValueIterable.create_from_iterables to create an instance of this type.

Constructor

new ValueIterable()

Implements:
  • AsyncIterable
Source:

Methods

(static) create_from_iterables(input_iterables, transform_fnopt, lockstep_thresholdopt) → {hyrrokkin_engine.ValueIterable}

Return an async iteratable based on a set of input iterables.
Parameters:
Name Type Attributes Description
input_iterables Array.<AsyncIterable> a list of one or more async iterables that provide input values
transform_fn transformFunction | asyncTransformFunction <optional>
a function to transform values from the input iterables
lockstep_threshold int <optional>
Specify that this many iterators opened over this iterable will be optimised to share a single set of iterators obtained from the input iterables. However, note that these iterators will yield values in lock-step. If more than this many iterators are opened, each subsequent iterator will open new input iterators.
Source:
Returns:
An async iterable
Type
hyrrokkin_engine.ValueIterable