Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "utils/async/tabulate-by/docs/types/index.d"

Index

Interfaces

Type aliases

Variables

Type aliases

Binary

Binary: (error: Error | null, group: string) => void

Callback function.

param

encountered error or null

param

value group

Type declaration

    • (error: Error | null, group: string): void

    • Parameters

      • error: Error | null
      • group: string

      Returns void

BinaryIndicator

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

Checks whether an element in a collection passes a test.

param

collection value

param

a callback to be invoked after processing a collection value

Type declaration

    • Parameters

      Returns void

Callback

Callback: Nullary | Unary | Binary

Callback function.

param

encountered error or null

param

value group

DoneBinary

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

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

param

encountered error or null

param

frequency table

Type declaration

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

    • Parameters

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

      Returns void

DoneCallback

DoneCallback: DoneNullary | DoneUnary | DoneBinary

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

param

encountered error or null

param

frequency table

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 | null) => void

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

param

encountered error or null

Type declaration

    • (error: Error | null): void

    • Parameters

      • error: Error | null

      Returns void

FactoryFunction

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

Invokes an indicator function for each element in a collection.

param

input collection

param

function to invoke upon completion

Type declaration

Indicator

Indicator: Unary | BinaryIndicator | TernaryIndicator | QuaternaryIndicator

Checks whether an element in a collection passes a test.

param

collection value

param

collection index

param

input collection

param

a callback to be invoked after processing a collection value

Nullary

Nullary: () => void

Callback function.

Type declaration

    • (): void

    • Returns void

QuaternaryIndicator

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

Checks whether an element in a collection passes a test.

param

collection value

param

collection index

param

input collection

param

a callback to be invoked after processing a collection value

Type declaration

TernaryIndicator

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

Checks whether an element in a collection passes a test.

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 | null) => void

Callback function.

param

encountered error or null

Type declaration

    • (error: Error | null): void

    • Parameters

      • error: Error | null

      Returns void

Variables

Export assignment tabulateByAsync

tabulateByAsync: TabulateByAsync

Generates a frequency table according to an indicator function.

Notes

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

  • The output frequency table is an array of arrays. Each sub-array corresponds to a unique value in the input collection and is structured as follows:

    • 0: unique value
    • 1: value count
    • 2: frequency percentage
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 whose return values are used to populate the output frequency table

param

function to invoke upon completion

throws

must provide valid options