Skip to content

uni-flow 公开 API(中文注解)


uni-flow 公开 API(中文注解) / SharedState

Interface: SharedState ​

Defined in: core/types.ts:110

工作流共享状态:Unit 间传递 task / params / output.<id> 等。 默认实现见 createSharedState。

Methods ​

delete() ​

delete(key): void

Defined in: core/types.ts:116

删除键。

Parameters ​

key ​

string

Returns ​

void


get() ​

get<T>(key): T | undefined

Defined in: core/types.ts:112

读取工作流 scope 下的键。

Type Parameters ​

T ​

T

Parameters ​

key ​

string

Returns ​

T | undefined


has() ​

has(key): boolean

Defined in: core/types.ts:118

是否存在键。

Parameters ​

key ​

string

Returns ​

boolean


scope() ​

scope(level): ScopedStateView

Defined in: core/types.ts:122

进入指定 scope 的视图。

Parameters ​

level ​

StateScope

Returns ​

ScopedStateView


set() ​

set<T>(key, value): void

Defined in: core/types.ts:114

写入工作流 scope 下的键。

Type Parameters ​

T ​

T

Parameters ​

key ​

string

value ​

T

Returns ​

void


snapshot() ​

snapshot(): Record<string, unknown>

Defined in: core/types.ts:120

导出当前快照(扁平对象)。

Returns ​

Record<string, unknown>


transaction() ​

transaction(fn): void

Defined in: core/types.ts:124

在事务中批量变更(冲突时可能抛错,视实现而定)。

Parameters ​

fn ​

(tx) => void

Returns ​

void

MIT Licensed