Skip to content

Latest commit

 

History

History
169 lines (96 loc) · 4.93 KB

Asynchronous.Callback_Object.md

File metadata and controls

169 lines (96 loc) · 4.93 KB

Class: Callback_Object<Value, Result, Parameters, Key>

Asynchronous.Callback_Object

Classy object for storing wrapper function state between iterations

Author

S0AndS0

License

AGPL-3.0

Type parameters

Name Type
Value unknown
Result unknown
Parameters extends unknown[] = unknown[]
Key Index_Or_Key

Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

• new Callback_Object<Value, Result, Parameters, Key>(options)

Builds new instance of Callback_Object to append to Iterator_Cascade_Callbacks.callbacks list

Type parameters

Name Type
Value unknown
Result unknown
Parameters extends unknown[] = unknown[]
Key unknown

Parameters

Name Type Description
options Object Labeled parameters
options.callback Callback_Function<Value, Result, Parameters, Key> Function that executes for each iteration of Asynchronous.Iterator_Cascade_Callbacks
options.name string Method name that instantiated callback, eg. "filter" or "map"
options.parameters Parameters Array of arguments that are passed to callback on each iteration
options.wrapper Callback_Wrapper<Value, Result, Parameters, Key> Function wrapper that handles input/output between Asynchronous.Callback_Function and Iterator_Cascade_Callbacks

See

Callback_Object_Base#constructor for name and parameters

Overrides

Callback_Object_Base.constructor

Defined in

src/asynchronous/callback-object.ts:34

Properties

callback

• callback: Callback_Function<Value, Result, Parameters, Key>

Defined in

src/asynchronous/callback-object.ts:23

name

• name: string

Inherited from

Callback_Object_Base.name

Defined in

src/lib/callback-object-base.ts:13

parameters

• parameters: Parameters

Inherited from

Callback_Object_Base.parameters

Defined in

src/lib/callback-object-base.ts:14

storage

• storage: Dictionary<unknown>

Inherited from

Callback_Object_Base.storage

Defined in

src/lib/callback-object-base.ts:15

wrapper

• wrapper: Callback_Wrapper<Value, Result, Parameters, Key>

Defined in

src/asynchronous/callback-object.ts:22

Methods

call

▸ call(iterator_cascade_callbacks): Promise<void>

Calls this.wrapper function with reference to this Callback_Object and Iterator_Cascade_Callbacks

Parameters

Name Type Description
iterator_cascade_callbacks Iterator_Cascade_Callbacks<unknown> Reference to Asynchronous.Iterator_Cascade_Callbacks instance

Returns

Promise<void>

Defined in

src/asynchronous/callback-object.ts:50