threading

import {...} from "@wangyaoshen/locus-core/lib/threading";

Thread management.

Classes​

• Thread

Interfaces​

• Promisable
• ThreadsCallback
• ThreadsFactory

Type Aliases​

Functions​

cancel​

public cancel...tasks: ThreadGenerator[]: void

Cancel all listed tasks.

Example:

const task = yield generatorFunction();

// do something concurrently

yield* cancel(task);

Parameters

• ...tasks: ThreadGenerator[]

  A list of tasks to cancel.

getTaskName​

public getTaskNametask: Generator: string

Parameters

• task: Generator

isPromisable​

public isPromisablevalue: any: value is Promisableany

Parameters

• value: any

isPromise​

public isPromisevalue: any: value is Promiseany

Check if the given value is a [Promise][promise].

Parameters

• value: any

  A possible Promise.

isThreadGenerator​

public isThreadGeneratorvalue: unknown: value is ThreadGenerator

Check if the given value is a ThreadGenerator.

Parameters

• value: unknown

  A possible thread ThreadGenerator.

join​

public join...tasks: ThreadGenerator[]: ThreadGenerator

public joinall: boolean...tasks: ThreadGenerator[]: ThreadGenerator

Pause the current generator until all listed tasks are finished.

Examples

Parameters

• ...tasks: ThreadGenerator[]

  A list of tasks to join.

setTaskName​

public setTaskNametask: Generatorsource: stringGeneratorunknownanyunknown: void

Parameters

• task: Generator
• source: stringGeneratorunknownanyunknown

spawn​

public spawntask: ThreadGenerator() => ThreadGenerator: ThreadGenerator

Run the given task concurrently.

Examples

Parameters

• task: ThreadGenerator() => ThreadGenerator

  Either a generator function or a task to run.

threads​

public threadsfactory: ThreadsFactorycallback?: ThreadsCallback: ThreadGenerator

Create a context in which generators can be run concurrently.

From the perspective of the external generator, threads is executed synchronously. By default, each scene generator is wrapped in its own threads generator.

Examples

Parameters

• factory: ThreadsFactory

  A function that returns the generator to run.

• callback?: ThreadsCallback

  Called whenever threads are created, canceled or finished. Used for debugging purposes.