tw5-typed / modules/syncer/syncAdaptor / SyncAdaptor

Interface: SyncAdaptor

modules/syncer/syncAdaptor.SyncAdaptor

SyncAdaptorModules

Url

https://tiddlywiki.com/dev/#SyncAdaptorModules

Table of contents

Properties

• name
• supportsLazyLoading
• wiki

Methods

• getTiddlerFileInfo
• getTiddlerInfo
• getUpdatedTiddlers
• isReady

Properties

name

• name: string

Defined in

src/modules/syncer/syncAdaptor.d.ts:36

---

supportsLazyLoading

• supportsLazyLoading: boolean

Defined in

src/modules/syncer/syncAdaptor.d.ts:37

---

wiki

• wiki: Wiki

Defined in

src/modules/syncer/syncAdaptor.d.ts:38

Methods

getTiddlerFileInfo

▸ getTiddlerFileInfo(title, callback): void

Parameters

Name	Type
title	string
callback	(error: null, fileInfo: IFileInfo) => void

Returns

void

Defined in

src/modules/syncer/syncAdaptor.d.ts:7

---

getTiddlerInfo

▸ getTiddlerInfo(title): IBootFilesIndexItem

Parameters

Name	Type
title	string

Returns

IBootFilesIndexItem

Defined in

src/modules/syncer/syncAdaptor.d.ts:11

---

getUpdatedTiddlers

▸ getUpdatedTiddlers(syncer, callback): void

Retrieves the titles of tiddlers that need to be updated from the server.

This method is optional. If an adaptor doesn't implement it then synchronisation will be unidirectional from the TiddlyWiki store to the adaptor, but not the other way.

The syncer will use the getUpdatedTiddlers() method in preference to the getSkinnyTiddlers() method.

|!Parameter |!Description | |syncer |Reference to the syncer object making the call | |callback |Callback function invoked with parameter err,data -- see below |

The data provided by the callback is as follows:

{
modifications: [<array of title>],
deletions: [<array of title>],
}

Parameters

Name	Type
syncer	Syncer
callback	(error: Error, changes: { deletions: string[] ; modifications: string[] }) => void

Returns

void

Defined in

src/modules/syncer/syncAdaptor.d.ts:34

---

isReady

▸ isReady(): boolean

Returns

boolean

Defined in

src/modules/syncer/syncAdaptor.d.ts:35