Skip to main content

Class: TJobManager

Defined in: jobs/job-manager.ts:54

Constructors​

Constructor​

new TJobManager(contexts): TJobManager

Defined in: jobs/job-manager.ts:82

Parameters​

contexts​

TJobContextTypes[]

Returns​

TJobManager

Properties​

additionalContext​

additionalContext: TJobContext | TPhysicsJobContext | TGameStateJobContext | TRenderJobContext | TAudioJobContext

Defined in: jobs/job-manager.ts:75

Methods​

do()​

do<TJobArgs, TJobResult>(job, args, transferList?): Promise<TJobResult>

Defined in: jobs/job-manager.ts:155

Type Parameters​

TJobArgs​

TJobArgs

TJobResult​

TJobResult

Parameters​

job​

TJobConfig<TJobContextTypes, TJobArgs, TJobResult>

args​

TJobArgs

transferList?​

Transferable[] = []

Returns​

Promise<TJobResult>


doRelayedJob()​

doRelayedJob(wrappedJob, port): Promise<void>

Defined in: jobs/job-manager.ts:179

Parameters​

wrappedJob​

TWrappedJob<unknown>

port​
postMessage​

(result) => void

Returns​

Promise<void>


onRelayedResult()​

onRelayedResult(wrappedResult): void

Defined in: jobs/job-manager.ts:205

Parameters​

wrappedResult​

TWrappedJobResult

Returns​

void


registerJob()​

registerJob<TContext, TJobArgs, TJobResult>(config, func): void

Defined in: jobs/job-manager.ts:88

Type Parameters​

TContext​

TContext extends TJobContextTypes = TJobContextTypes

TJobArgs​

TJobArgs = unknown

TJobResult​

TJobResult = unknown

Parameters​

config​

TJobConfig<TContext, TJobArgs, TJobResult>

func​

TJobFunc<TContextTypeMap[TContext], TJobArgs, TJobResult>

Returns​

void


setRelay()​

setRelay(contexts, portOrManager): void

Defined in: jobs/job-manager.ts:111

Set relay function for the specified job contexts. The relay function sends a message containing the wrapped job to the specified message port. If a relay function already exists for a given context, it will be replaced.

Parameters​

contexts​

TJobContextTypes[]

An array of job contexts.

portOrManager​

MessagePort | (() => TJobProcessor)

The message port or job manager to which the relay function will send the message.

Returns​

void