TaskGroup

clay .async. TaskGroup

# new TaskGroup()

Source:

async/TaskGroup.js, line 9

Extends

clay.async.Task

Methods

# after(name, action, contextopt)

Source:

core/mixin/notifier.js, line 125

Inherited From:

clay.async.Task#after

Mixes In:

clay.core.mixin.notifier.after

Alias of once('after' + name)

Parameters:

Name	Type	Attributes	Description
`name`	string
`action`	function
`context`	Object	<optional>

# all(tasks)

Source:

async/TaskGroup.js, line 43

Wait for all given tasks successed, task can also be any notifier object which will trigger success and error events. Like clay.Texture2D, clay.TextureCube, clay.loader.GLTF.

Example

// Load texture list
    var list = ['a.jpg', 'b.jpg', 'c.jpg']
    var textures = list.map(function (src) {
        var texture = new clay.Texture2D();
        texture.load(src);
        return texture;
    });
    var taskGroup = new clay.async.TaskGroup();
    taskGroup.all(textures).success(function () {
        // Do some thing after all textures loaded
    });

Parameters:

Name	Type	Description
`tasks`	Array.<clay.async.Task>

# allSettled(tasks) → {clay.async.TaskGroup}

Source:

async/TaskGroup.js, line 94

Wait for all given tasks finished, either successed or failed

Parameters:

Name	Type	Description
`tasks`	Array.<clay.async.Task>

Returns:

Type: clay.async.TaskGroup

# before(name, action, contextopt)

Source:

core/mixin/notifier.js, line 110

Inherited From:

clay.async.Task#before

Mixes In:

clay.core.mixin.notifier.before

Alias of once('before' + name)

Parameters:

Name	Type	Attributes	Description
`name`	string
`action`	function
`context`	Object	<optional>

# error(action, contextopt)

Source:

core/mixin/notifier.js, line 149

Inherited From:

clay.async.Task#error

Mixes In:

clay.core.mixin.notifier.error

Alias of on('error')

Parameters:

Name	Type	Attributes	Description
`action`	function
`context`	Object	<optional>

# getFulfilledNumber(recursiveopt) → {number}

Source:

async/TaskGroup.js, line 146

Get successed sub tasks number, recursive can be true if sub task is also a TaskGroup.

Parameters:

Name	Type	Attributes	Description
`recursive`	boolean	<optional>

Returns:

Type: number

# getRejectedNumber(recursiveopt) → {number}

Source:

async/TaskGroup.js, line 168

Get failed sub tasks number, recursive can be true if sub task is also a TaskGroup.

Parameters:

Name	Type	Attributes	Description
`recursive`	boolean	<optional>

Returns:

Type: number

# getSettledNumber(recursiveopt) → {number}

Source:

async/TaskGroup.js, line 190

Get finished sub tasks number, recursive can be true if sub task is also a TaskGroup.

Parameters:

Name	Type	Attributes	Description
`recursive`	boolean	<optional>

Returns:

Type: number

# getTaskNumber(recursiveopt) → {number}

Source:

async/TaskGroup.js, line 213

Get all sub tasks number, recursive can be true if sub task is also a TaskGroup.

Parameters:

Name	Type	Attributes	Description
`recursive`	boolean	<optional>

Returns:

Type: number

# has(name, action) → {boolean}

Source:

core/mixin/notifier.js, line 187

Inherited From:

clay.async.Task#has

Mixes In:

clay.core.mixin.notifier.has

If registered the event handler

Parameters:

Name	Type	Description
`name`	string
`action`	function

Returns:

Type: boolean

# isFullfilled() → {boolean}

Source:

async/Task.js, line 36

Inherited From:

clay.async.Task#isFullfilled

If task successed

Returns:

Type: boolean

# isRejected() → {boolean}

Source:

async/Task.js, line 43

Inherited From:

clay.async.Task#isRejected

If task failed

Returns:

Type: boolean

# isSettled() → {boolean}

Source:

async/Task.js, line 50

Inherited From:

clay.async.Task#isSettled

If task finished, either successed or failed

Returns:

Type: boolean

# off(action, contextopt)

Source:

core/mixin/notifier.js, line 159

Inherited From:

clay.async.Task#off

Mixes In:

clay.core.mixin.notifier.off

Remove event listener

Parameters:

Name	Type	Attributes	Description
`action`	function
`context`	Object	<optional>

# on(name, action, contextopt)

Source:

core/mixin/notifier.js, line 65

Inherited From:

clay.async.Task#on

Mixes In:

clay.core.mixin.notifier.on

Register event handler

Parameters:

Name	Type	Attributes	Description
`name`	string
`action`	function
`context`	Object	<optional>

# once(name, action, contextopt)

Source:

core/mixin/notifier.js, line 91

Inherited From:

clay.async.Task#once

Mixes In:

clay.core.mixin.notifier.once

Register event, event will only be triggered once and then removed

Parameters:

Name	Type	Attributes	Description
`name`	string
`action`	function
`context`	Object	<optional>

# reject(err)

Source:

async/Task.js, line 27

Inherited From:

clay.async.Task#reject

Task failed

Parameters:

Name	Type	Description
`err`

# resolve(data)

Source:

async/Task.js, line 18

Inherited From:

clay.async.Task#resolve

Task successed

Parameters:

Name	Type	Description
`data`

# success(action, contextopt)

Source:

core/mixin/notifier.js, line 139

Inherited From:

clay.async.Task#success

Mixes In:

clay.core.mixin.notifier.success

Alias of on('success')

Parameters:

Name	Type	Attributes	Description
`action`	function
`context`	Object	<optional>

# trigger(name)

Source:

core/mixin/notifier.js, line 14

Inherited From:

clay.async.Task#trigger

Mixes In:

clay.core.mixin.notifier.trigger

Trigger event

Parameters:

Name	Type	Description
`name`	string