Global

Type Definitions

evaluateItem(value) → {boolean}

Source:

Evaluate the supplied item returning a boolean

Parameters:
Name Type Description
value *

the value of the current source item
Returns:
Type
boolean

itemCallback(value, index)

Source:

A function that receives the items of an iterable

Parameters:
Name Type Description
value *

the value of the current source item
index Number

the index of the item as per the source iteration

itemTest(value, index) → {boolean}

Source:

Evaluate the supplied item returning a boolean

Parameters:
Name Type Description
value *

the value of the current source item
index Number

the index of the item as per the source iteration
Returns:
Type
boolean

minMaxCallback(item, comparisonItemopt) → {*}

Source:

Called by the min and max operators to identify comparison value or ordering.

There are 2 forms of this function. If the function takes only 1 argument, it is assume that the function returns a string or number to be used for comparison.

If the function takes 2 arguments, then it must compare the 2 arguments and return -1 if less than, 0 if equal, and +1 is greater.

Parameters:
Name Type Attributes Description
item *

to be considered for sequence
comparisonItem * <optional>

an item to be compared to the first item
Returns:

a value to be compared, or -1, 0, +1 to indicate comparison

Type
*

missingValueFn(filteredItem, nonFilteredItem) → {*}

Source:

Called by the filter function, when a set of items are filtered

Parameters:
Name Type Description
filteredItem *

the first filtered item
nonFilteredItem *

the first non filtered item
Returns:

a value to be emitted before the nonFilteredItem

Type
*

overFlowEventCallback() → {*}

Source:

Callback to get description of an overflow event.

Returns:

The item to emit when we persistent buffer overflows. If underfined no overflow event will be emitted

Type
*

PersistedItem

Source:
Properties:
Name Type Description
value string

the emitted value from the persisted store as a Buffer (ie: you may need to apply, toString())
completed function

A function that must be called to removed the item
Type:
  • object

pumpCallback(target, hasStopped)

Source:

The callback function invoked to generate an push based async iterator

Parameters:
Name Type Description
target iterator

The target iterator object (supports next, return and throw)

  • target.next - call this function to push a value into the iteration - returns a promise when the consumer has consumed this item. Returns a promise that resolves to {value, done}
  • target.return - call this function when there are no more items to be pushed. Signal to consumer that the iteration has completed
  • target.throw - call this function when an error has been generated - raises the error within the consuming iteration
hasStopped promise

a promise that resolves, when the consumer has stopped iterating. This is an alternative mechanism to identify a stopped iteration

  • hasStopped.now() - promise additonally supports a now() that returns true, when the consumer has stopped iterating

reducerCallback(accumulator, item, index) → {*}

Source:

Called by the filter function, when a set of items are filtered

Parameters:
Name Type Description
accumulator *

the current accumulator value (result of previous call)
item *

the current item to be processed
index Number

the index of the item within the iteration
Returns:

the new accumulator value

Type
*

triggerCallback(value, currentBatch) → {boolean}

Source:

Indicate if a batched buffer iteration should be emitted

Parameters:
Name Type Description
value *

the value of the current source item
currentBatch Array

the current array of collected items - the last item will be value
Returns:

Returning true indicate that item can be emitted

Type
boolean