MeshFlow Core API

---

MeshFlow Core API / useScheduler

Function: useScheduler()

useScheduler<T, P, B, NM>(config, dependency, history, hooks, UITrigger): object

Defined in: engine/useScheduler.ts:12

Type Parameters

T

T

P

P extends MeshPath

B

B extends Record<string, any> = StandardUITrigger<T>

NM

NM = any

Parameters

config

useEntangleStep

number

useGreedy

boolean

dependency

GetAllNextDependency

(targetUid) => number[]

GetAllPrevDependency

(targetUid) => number[]

GetDependencyOrder

() => number[][]

GetNextDependency

(targetUid) => number[]

GetPrevDependency

(targetUid) => number[]

GetUidToLevelMap

() => Map<number, number>

history

Partial<{ createHistoryAction: any; pushIntoHistory: any; }>

hooks

callOnError

any

callOnStart

any

callOnSuccess

any

emit

MeshEmit

UITrigger

B

Returns

object

batchNotify

batchNotify: (updates) => void

Parameters

updates

object[]

Returns

void

CancelTask

CancelTask: () => void

Returns

void

GetBucket

GetBucket: (bucketId) => SchemaBucket<P>

Parameters

bucketId

number

Returns

SchemaBucket<P>

GetGroupByPath

GetGroupByPath: (path) => MeshFlowGroupNode<MeshPath>

Parameters

path

MeshPath

Returns

MeshFlowGroupNode<MeshPath>

GetNodeByPath

GetNodeByPath: (path) => MeshFlowTaskNode<P, any, NM>

Parameters

path

P

Returns

MeshFlowTaskNode<P, any, NM>

notify

notify: (path) => void

Parameters

path

P

Returns

void

notifyAll

notifyAll: () => Promise<void>

Returns

Promise<void>

refresTarget

refresTarget: (uid) => void

Parameters

uid

number

Returns

void

registerGroupNode

registerGroupNode: (groupMeta) => MeshFlowGroupNode<P>

Parameters

groupMeta

Omit<MeshFlowGroupNode<P>, "createView" | "calledBy" | "uid" | "dirtySignal">

Returns

MeshFlowGroupNode<P>

registerNode

registerNode: (nodeMeta) => MeshFlowTaskNode<P, any, NM>

Parameters

nodeMeta

Omit<MeshFlowTaskNode<P>, "createView" | "proxy" | "dependOn" | "calledBy" | "uid" | "dirtySignal" | "nodeBucket">

Returns

MeshFlowTaskNode<P, any, NM>

SetBucket

SetBucket: (newBucket) => number

Parameters

newBucket

SchemaBucket<P>

Returns

number

stageValueFn

stageValueFn: (uid, key, value) => void

Parameters

uid

number

key

SuggestKey<NM>

value

any

Returns

void

UidToNodeMap

UidToNodeMap: MeshFlowTaskNode<P, any, NM>[]

UITrigger

UITrigger: B

updateEntangleLevel

updateEntangleLevel: () => void

Returns

void

useEntangle

useEntangle: (config) => void

Parameters

config

EntangleArgType<P>

Returns

void