src/bundlingCalls/task.ts
Properties |
|
Methods |
constructor(apiCall: SimpleCallbackFunction, bundlingRequest: literal type, bundledField: string, subresponseField?: string | null)
|
||||||||||||||||||||
Defined in src/bundlingCalls/task.ts:128
|
||||||||||||||||||||
A task coordinates the execution of a single bundle.
Parameters :
|
_apiCall |
Type : SimpleCallbackFunction
|
Defined in src/bundlingCalls/task.ts:123
|
_bundledField |
Type : string
|
Defined in src/bundlingCalls/task.ts:125
|
_data |
Type : TaskData[]
|
Defined in src/bundlingCalls/task.ts:127
|
_request |
Type : literal type
|
Defined in src/bundlingCalls/task.ts:124
|
Optional _subresponseField |
Type : string | null
|
Defined in src/bundlingCalls/task.ts:126
|
Optional callCanceller |
Type : GRPCCallResult
|
Defined in src/bundlingCalls/task.ts:128
|
cancel | ||||||||
cancel(id: string)
|
||||||||
Defined in src/bundlingCalls/task.ts:251
|
||||||||
Cancels a part of elements.
Parameters :
Returns :
boolean
Whether the entire task will be canceled or not. |
extend | ||||||||||||||||
extend(elements: TaskElement[], bytes: number, callback: TaskCallback)
|
||||||||||||||||
Defined in src/bundlingCalls/task.ts:239
|
||||||||||||||||
Appends the list of elements into the task.
Parameters :
Returns :
void
|
getElementCount |
getElementCount()
|
Defined in src/bundlingCalls/task.ts:158
|
Returns the number of elements in a task.
Returns :
number
The number of elements. |
getRequestByteSize |
getRequestByteSize()
|
Defined in src/bundlingCalls/task.ts:169
|
Returns the total byte size of the elements in a task.
Returns :
number
The byte size. |
run |
run()
|
Defined in src/bundlingCalls/task.ts:180
|
Invokes the actual API call with current elements.
Returns :
{}
|