Skip to main content

tw5-typed / modules/syncer/syncer / Syncer

Class: Syncer

modules/syncer/syncer.Syncer

Table of contents​

Constructors​

Properties​

Methods​

Constructors​

constructor​

• new Syncer(): Syncer

Returns​

Syncer

Properties​

pollTimerInterval​

• pollTimerInterval: number

Defined in​

src/modules/syncer/syncer.d.ts:3

syncadaptor​

• Optional syncadaptor: SyncAdaptor

Defined in​

src/modules/syncer/syncer.d.ts:4

Methods​

getSyncedTiddlers​

▸ getSyncedTiddlers(): string[]

Return an array of the tiddler titles that are subjected to syncing

Returns​

string[]

Defined in​

src/modules/syncer/syncer.d.ts:24

getTiddlerRevision​

▸ getTiddlerRevision(title): string

Get stringified revision number, for example, '0'.

Parameters​

NameType
titlestring

Returns​

string

Defined in​

src/modules/syncer/syncer.d.ts:28

isDirty​

▸ isDirty(): boolean

Checks whether the wiki is dirty (ie the window shouldn't be closed)

Returns​

boolean

Defined in​

src/modules/syncer/syncer.d.ts:20

processTaskQueue​

▸ processTaskQueue(): void

Process the next task

Returns​

void

Defined in​

src/modules/syncer/syncer.d.ts:12

readTiddlerInfo​

▸ readTiddlerInfo(): void

Read (or re-read) the latest tiddler info from the store

Returns​

void

Defined in​

src/modules/syncer/syncer.d.ts:32

syncFromServer​

▸ syncFromServer(): void

Synchronise from the server by reading the skinny tiddler list and queuing up loads for any tiddlers that we don't already have up to date

Returns​

void

Defined in​

src/modules/syncer/syncer.d.ts:8

updateDirtyStatus​

▸ updateDirtyStatus(): void

Update the document body with the class "tc-dirty" if the wiki has unsaved/unsynced changes

Returns​

void

Defined in​

src/modules/syncer/syncer.d.ts:16