Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "utils/async/inmap/docs/types/index.d"

Index

Interfaces

Type aliases

Variables

Type aliases

Binary

Binary: (error: Error | null, result: any) => void

Callback function.

param

error argument

param

value used to update the collection

Type declaration

    • (error: Error | null, result: any): void

    • Parameters

      • error: Error | null
      • result: any

      Returns void

BinaryFcn

BinaryFcn: (value: any, next: Callback) => void

Function invoked for each element in a collection.

param

collection value

param

a callback to be invoked after processing a collection value

Type declaration

    • Parameters

      Returns void

Callback

Callback: Unary | Binary

Callback function.

param

error argument

param

value used to update the collection

DoneBinary

DoneBinary: (error: Error, collection: Collection) => void

Callback invoked either upon processing all collection elements or upon encountering an error.

param

error argument

param

updated input collection

Type declaration

    • Parameters

      Returns void

DoneCallback

DoneCallback: DoneNullary | DoneUnary | DoneBinary

Callback invoked either upon processing all collection elements or upon encountering an error.

param

error argument

param

updated input collection

DoneNullary

DoneNullary: () => void

Callback invoked either upon processing all collection elements or upon encountering an error.

Type declaration

    • (): void

    • Returns void

DoneUnary

DoneUnary: (error: Error) => void

Callback invoked either upon processing all collection elements or upon encountering an error.

param

error argument

Type declaration

    • (error: Error): void

    • Parameters

      • error: Error

      Returns void

FactoryFunction

FactoryFunction: (collection: Collection, done: DoneCallback) => void

Invokes the provided function for each element in a collection and updates a collection in-place.

param

input collection

param

function to invoke upon completion

Type declaration

Fcn

Fcn: BinaryFcn | TernaryFcn | QuaternaryFcn

Function invoked for each element in a collection.

param

collection value

param

collection index

param

input collection

param

a callback to be invoked after processing a collection value

QuaternaryFcn

QuaternaryFcn: (value: any, index: number, collection: Collection, next: Callback) => void

Function invoked for each element in a collection.

param

collection value

param

collection index

param

input collection

param

a callback to be invoked after processing a collection value

Type declaration

TernaryFcn

TernaryFcn: (value: any, index: number, next: Callback) => void

Function invoked for each element in a collection.

param

collection value

param

collection index

param

a callback to be invoked after processing a collection value

Type declaration

    • (value: any, index: number, next: Callback): void

    • Parameters

      • value: any
      • index: number
      • next: Callback

      Returns void

Unary

Unary: (error: Error) => void

Callback function.

param

error argument

param

value used to update the collection

Type declaration

    • (error: Error): void

    • Parameters

      • error: Error

      Returns void

Variables

Export assignment inmapAsync

inmapAsync: InMapAsync

Invokes a function once for each element in a collection and updates a collection in-place.

Notes
  • If a provided function calls the provided callback with a truthy error argument, the function suspends execution and immediately calls the done callback for subsequent error handling. Note, however, that the function may have mutated an input collection during prior invocations, resulting in a partially mutated collection.
  • This function does not guarantee that execution is asynchronous. To do so, wrap the done callback in a function which either executes at the end of the current stack (e.g., nextTick) or during a subsequent turn of the event loop (e.g., setImmediate, setTimeout).
param

input collection

param

function options

param

execution context

param

maximum number of pending invocations at any one time

param

boolean indicating whether to wait for a previous invocation to complete before invoking a provided function for the next element in a collection (default: false)

param

function to invoke for each element in a collection

param

function to invoke upon completion

throws

must provide valid options