Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "utils/async/map-function/docs/types/index.d"

Index

Interfaces

Type aliases

Variables

Type aliases

Binary

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

Callback function.

param

encountered error or null

param

result

Type declaration

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

    • Parameters

      • error: Error | null
      • result: any

      Returns void

Callback

Callback: Nullary | Unary | Binary

Callback function.

param

encountered error or null

param

result

DoneBinary

DoneBinary: (error: Error | null, results: Array<any>) => void

Callback invoked upon completion.

param

encountered error or null

param

results

Type declaration

    • (error: Error | null, results: Array<any>): void

    • Parameters

      • error: Error | null
      • results: Array<any>

      Returns void

DoneCallback

DoneCallback: DoneNullary | DoneUnary | DoneBinary

Callback invoked upon completion.

param

encountered error or null

param

results

DoneNullary

DoneNullary: () => void

Callback invoked upon completion.

Type declaration

    • (): void

    • Returns void

DoneUnary

DoneUnary: (error: Error | null) => void

Callback invoked upon completion.

param

encountered error or null

Type declaration

    • (error: Error | null): void

    • Parameters

      • error: Error | null

      Returns void

FactoryFunction

FactoryFunction: (n: number, done: DoneCallback) => void

Maps keys from one object to a new object having the same values.

param

number of function invocations

param

function to invoke upon completion

throws

first argument must be a nonnegative integer

Type declaration

Fcn

Fcn: (index: number, next: Callback) => void

Function to invoke.

param

invocation index (starting from zero)

param

callback to be invoked upon function completion

Type declaration

    • Parameters

      Returns void

Nullary

Nullary: () => void

Callback function.

Type declaration

    • (): void

    • Returns void

Unary

Unary: (error: Error | null) => void

Callback function.

param

encountered error or null

Type declaration

    • (error: Error | null): void

    • Parameters

      • error: Error | null

      Returns void

Variables

Export assignment mapFunAsync

mapFunAsync: MapFunAsync

Invokes a function n times and returns an array of accumulated function return values.

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.
  • 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

function to invoke

param

number of function invocations

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 again (default: false)

param

callback to invoke upon invoking a function n times

throws

second argument must be a nonnegative integer

throws

must provide valid options