Skip to content

Documentation / @geoverse/editor-core / SyncScheduler

Class: SyncScheduler

Defined in: packages/editor-core/src/sync/scheduler.ts:59

Constructors

Constructor

ts
new SyncScheduler(client, options?): SyncScheduler;

Defined in: packages/editor-core/src/sync/scheduler.ts:73

Parameters

client

SyncClient

options?

SyncSchedulerOptions = {}

Returns

SyncScheduler

Accessors

hasPending

Get Signature

ts
get hasPending(): boolean;

Defined in: packages/editor-core/src/sync/scheduler.ts:97

Returns

boolean


isOnline

Get Signature

ts
get isOnline(): boolean;

Defined in: packages/editor-core/src/sync/scheduler.ts:93

Returns

boolean


state

Get Signature

ts
get state(): SyncState;

Defined in: packages/editor-core/src/sync/scheduler.ts:89

Returns

SyncState

Methods

backoffDelay()

ts
backoffDelay(attempt): number;

Defined in: packages/editor-core/src/sync/scheduler.ts:102

第 attempt 次重试(0 基)的退避毫秒。

Parameters

attempt

number

Returns

number


flush()

ts
flush(): Promise<FlushResult>;

Defined in: packages/editor-core/src/sync/scheduler.ts:124

尝试提交:离线→queued;在线→commit 并对瞬时错误指数退避重试。 conflict / committed / noop 直接返回(非重试)。并发调用复用进行中的 flush。

Returns

Promise<FlushResult>


setOnline()

ts
setOnline(online): void | Promise<FlushResult>;

Defined in: packages/editor-core/src/sync/scheduler.ts:108

切换在线态;恢复在线且 autoFlush 时自动 flush(返回其 Promise 便于测试 await)。

Parameters

online

boolean

Returns

void | Promise<FlushResult>