Xivgear Types Documentation
Preparing search index...
@xivgear/gearplan-frontend
workers/worker_pool
WorkerPool
Class WorkerPool
Index
Constructors
constructor
Properties
max
Workers
min
Workers
worker
Id
Accessors
num
Free
Workers
num
Initializing
Workers
Methods
cancel
Job
ping
set
Sheet
set
Worker
Provider
submit
Task
Constructors
constructor
new
WorkerPool
(
minWorkers
:
number
,
maxWorkers
:
number
)
:
WorkerPool
Parameters
minWorkers
:
number
maxWorkers
:
number
Returns
WorkerPool
Properties
Readonly
max
Workers
maxWorkers
:
number
Readonly
min
Workers
minWorkers
:
number
worker
Id
workerId
:
number
= 0
Accessors
num
Free
Workers
get
numFreeWorkers
()
:
number
Returns
number
num
Initializing
Workers
get
numInitializingWorkers
()
:
number
Returns
number
Methods
cancel
Job
cancelJob
(
id
:
number
)
:
void
Parameters
id
:
number
Returns
void
ping
ping
<
X
>
(
value
:
X
,
waitMs
:
number
)
:
Promise
<
PingData
>
Type Parameters
X
Parameters
value
:
X
waitMs
:
number
Returns
Promise
<
PingData
>
set
Sheet
setSheet
(
sheet
:
GearPlanSheet
)
:
Promise
<
void
>
Parameters
sheet
:
GearPlanSheet
Returns
Promise
<
void
>
set
Worker
Provider
setWorkerProvider
(
provider
:
WorkerCreator
)
:
void
Parameters
provider
:
WorkerCreator
Returns
void
submit
Task
submitTask
<
T
extends
AnyJobContext
=
never
>
(
request
:
RequestTypeOf
<
T
>
,
updateCallback
?:
JobUpdateCallback
<
T
>
,
)
:
{
jobId
:
number
;
promise
:
Promise
<
ResponseTypeOf
<
T
>
>
}
Type Parameters
T
extends
AnyJobContext
=
never
Parameters
request
:
RequestTypeOf
<
T
>
Optional
updateCallback
:
JobUpdateCallback
<
T
>
Returns
{
jobId
:
number
;
promise
:
Promise
<
ResponseTypeOf
<
T
>
>
}
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
max
Workers
min
Workers
worker
Id
Accessors
num
Free
Workers
num
Initializing
Workers
Methods
cancel
Job
ping
set
Sheet
set
Worker
Provider
submit
Task
Xivgear Types Documentation
Loading...