MeshFlow Core API

---

MeshFlow Core API / MeshScheduler

Class: MeshScheduler<T, P, B, NM>

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

Constructors

Constructor

new MeshScheduler<T, P, B, NM>(config, dependency, history, hooks, UITrigger): MeshScheduler<T, P, B, NM>

Defined in: engine/useScheduler.ts:67

Parameters

config

NODE_QUOTA_PER_FRAME

number

useEntangleStep

number

useGreedy

boolean

dependency

_GetAllNextDependency

(targetUid) => number[]

_GetAllPrevDependency

(targetUid) => number[]

_GetNextDependency

(targetUid) => number[]

_GetPrevDependency

(targetUid) => number[]

_GetUidToLevelMap

() => Map<number, number>

GetDependencyOrder

() => number[][]

history

InternalMeshFlowHistory

hooks

callOnError

any

callOnStart

any

callOnSuccess

any

emit

MeshEmit

UITrigger

B

Returns

MeshScheduler<T, P, B, NM>

Methods

_batchNotify()

_batchNotify(updates, source?): void

Defined in: engine/useScheduler.ts:371

Parameters

updates

object[]

source?

number = 0

Returns

void

---

_requestUpdate()

_requestUpdate(): void

Defined in: engine/useScheduler.ts:184

Returns

void

---

flushUpdate()

flushUpdate(): Promise<void>

Defined in: engine/useScheduler.ts:160

Returns

Promise<void>

---

GetBucket()

GetBucket(bucketId): SchemaBucket<P>

Defined in: engine/useScheduler.ts:330

Parameters

bucketId

number

Returns

SchemaBucket<P>

---

GetGroupByPath()

GetGroupByPath(path): MeshFlowGroupNode<MeshPath>

Defined in: engine/useScheduler.ts:319

Parameters

path

MeshPath

Returns

MeshFlowGroupNode<MeshPath>

---

GetMaxUid()

GetMaxUid(): number

Defined in: engine/useScheduler.ts:336

Returns

number

---

GetNodeByPath()

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

Defined in: engine/useScheduler.ts:297

Parameters

path

P

Returns

MeshFlowTaskNode<P, any, NM>

---

GetNodeByUid()

GetNodeByUid(uid): MeshFlowTaskNode<P, any, NM>

Defined in: engine/useScheduler.ts:309

Parameters

uid

number

Returns

MeshFlowTaskNode<P, any, NM>

---

GetPathByUid()

GetPathByUid(uid): P

Defined in: engine/useScheduler.ts:315

Parameters

uid

number

Returns

P

---

notify()

notify(path, key): void

Defined in: engine/useScheduler.ts:340

Parameters

path

P

key

SuggestKey<NM>

Returns

void

---

registerGroupNode()

registerGroupNode(groupMeta): MeshFlowGroupNode<P>

Defined in: engine/useScheduler.ts:275

Parameters

groupMeta

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

Returns

MeshFlowGroupNode<P>

---

registerNode()

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

Defined in: engine/useScheduler.ts:244

Parameters

nodeMeta

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

Returns

MeshFlowTaskNode<P, any, NM>

---

SetBucket()

SetBucket(newBucket): number

Defined in: engine/useScheduler.ts:326

Parameters

newBucket

SchemaBucket<P>

Returns

number

Internal

---

SilentSet()

SilentSet(path, key, value): boolean

Defined in: engine/useScheduler.ts:451

Parameters

path

P

key

SuggestKey<NM>

value

any

Returns

boolean

Properties

_flushPathPendingMap

_flushPathPendingMap: number[] = []

Defined in: engine/useScheduler.ts:35

---

_timeScheduler

_timeScheduler: object

Defined in: engine/useScheduler.ts:52

_getIsFirstFrame

_getIsFirstFrame: () => boolean

Returns

boolean

_shouldYield()

_shouldYield(): boolean

Returns

boolean

_yieldToMain()

_yieldToMain(): Promise<void>

Returns

Promise<void>

reset()

reset(): void

Returns

void

---

config

config: object

Defined in: engine/useScheduler.ts:68

NODE_QUOTA_PER_FRAME

NODE_QUOTA_PER_FRAME: number

useEntangleStep

useEntangleStep: number

useGreedy

useGreedy: boolean

---

dependency

dependency: object

Defined in: engine/useScheduler.ts:69

_GetAllNextDependency

_GetAllNextDependency: (targetUid) => number[]

Parameters

targetUid

number

Returns

number[]

_GetAllPrevDependency

_GetAllPrevDependency: (targetUid) => number[]

Parameters

targetUid

number

Returns

number[]

_GetNextDependency

_GetNextDependency: (targetUid) => number[]

Parameters

targetUid

number

Returns

number[]

_GetPrevDependency

_GetPrevDependency: (targetUid) => number[]

Parameters

targetUid

number

Returns

number[]

_GetUidToLevelMap

_GetUidToLevelMap: () => Map<number, number>

Returns

Map<number, number>

GetDependencyOrder

GetDependencyOrder: () => number[][]

Returns

number[][]

---

dispose

dispose: () => void

Defined in: engine/useScheduler.ts:44

Returns

void

---

history

history: InternalMeshFlowHistory

Defined in: engine/useScheduler.ts:77

---

hooks

hooks: object

Defined in: engine/useScheduler.ts:78

callOnError

callOnError: any

callOnStart

callOnStart: any

callOnSuccess

callOnSuccess: any

emit

emit: MeshEmit

---

SettleTasks

SettleTasks: (array) => void

Defined in: engine/useScheduler.ts:49

Parameters

array

TransactionArray<P, NM>

Returns

void

---

uid

uid: number = 0

Defined in: engine/useScheduler.ts:18

---

UITrigger

UITrigger: B

Defined in: engine/useScheduler.ts:79