tw5-typed 0.4.9 → 0.5.0

package/README.md

@@ -2,6 +2,8 @@
 
 TypeScript type definitions for TiddlyWiki5.
 
+[Doc Site - tiddly-gittly.github.io/TW5-Typed](https://tiddly-gittly.github.io/TW5-Typed/)
+
 ## Usage
 
 First, install it as dev-dependency:
@@ -59,3 +61,10 @@ You can add new `*.d.ts` file to contain your types:
 ### Test in your node_modules
 
 To rapid prototype the type, just right click a type to open `.d.ts` file in the `node_modules`, and try create new file there, and copy to this repo after a success.
+
+### Before publish
+
+Make sure doc build and test are passed.
+
+1. Doc: `pnpm run docs:generate && pnpm run docs:dev`, see `.github\workflows\deploy-docs-to-github-pages.yml`
+1. Tests: `pnpm run check`, see `.github\workflows\test.yml`

package/package.json

@@ -1,8 +1,18 @@
 {
+  "name": "tw5-typed",
+  "version": "0.5.0",
+  "scripts": {
+    "check": "tsc --noEmit && eslint src/**/*.ts",
+    "docs": "docs-ts",
+    "docs:build": "docusaurus build",
+    "docs:dev": "docusaurus start",
+    "docs:generate": "npm run docs:generate:api && npm run docs:generate:copy",
+    "docs:generate:api": "rimraf docs/api && typedoc --options typedoc.json",
+    "docs:generate:copy": "zx scripts/copy-readme.mjs",
+    "prepublishOnly": "tsc --noEmit"
+  },
   "description": "Types for tiddlywiki",
   "license": "MIT",
-  "name": "tw5-typed",
-  "version": "0.4.9",
   "url": "https://github.com/tiddly-gittly/tw5-typed",
   "homepage": "https://github.com/tiddly-gittly/tw5-typed",
   "bugs": {
@@ -16,10 +26,6 @@
   "files": [
     "src/"
   ],
-  "scripts": {
-    "check": "tsc --noEmit && eslint src/**/*.ts",
-    "prepublishOnly": "tsc --noEmit"
-  },
   "husky": {
     "hooks": {
       "pre-commit": "lint-staged"
@@ -33,20 +39,31 @@
       "node --max_old_space_size=8192 ./node_modules/eslint/bin/eslint.js --fix --color --cache --quiet"
     ]
   },
+  "dependencies": {
+    "@types/codemirror": "^5.60.15",
+    "@types/echarts": "^4.9.22",
+    "@types/node": "^20.11.24"
+  },
   "devDependencies": {
+    "@docusaurus/core": "^3.1.1",
+    "@docusaurus/preset-classic": "^3.1.1",
+    "@docusaurus/types": "^3.1.1",
+    "@mdx-js/react": "^3.0.1",
     "@modern-js/eslint-config": "latest",
     "@modern-js/tsconfig": "latest",
+    "docs-ts": "^0.8.0",
     "dprint": "^0.45.0",
-    "eslint-config-tidgi": "^1.1.5",
-    "husky": "^8.0.2",
-    "lint-staged": "^13.1.0",
-    "rimraf": "^3.0.2",
-    "tiddlywiki": "^5.2.5",
-    "typescript": "^4.9.4"
-  },
-  "dependencies": {
-    "@types/codemirror": "^5.60.6",
-    "@types/echarts": "^4.9.16",
-    "@types/node": "^18.11.9"
+    "eslint-config-tidgi": "^1.2.2",
+    "husky": "^9.0.11",
+    "lint-staged": "^15.2.2",
+    "prism-react-renderer": "^2.3.1",
+    "react": "^18.2.0",
+    "rimraf": "^5.0.5",
+    "tiddlywiki": "^5.3.3",
+    "type-fest": "^4.10.3",
+    "typedoc": "^0.25.9",
+    "typedoc-plugin-markdown": "^3.17.1",
+    "typescript": "^5.3.3",
+    "zx": "^7.2.3"
   }
 }

package/src/boot/config.d.ts

@@ -13,6 +13,7 @@ declare module 'tiddlywiki' {
   export type ITWConfig = IConfig;
 
   interface IConfig {
+    [configName: string]: any;
     /** Map type to file content type */
     contentTypeInfo: Record<string, IContentTypeInfo>;
     /** @default 'TIDDLYWIKI_EDITION_PATH' */
@@ -21,6 +22,7 @@ declare module 'tiddlywiki' {
     editionsPath: string;
     /** Map file extension */
     fileExtensionInfo: Record<string, IFileExtensionInfo>;
+    htmlUnsafeElements: string[];
     /**
      * @default '^\\/\\*\\\\(?:\\r?\\n)((?:^[^\\r\\n]*(?:\\r?\\n))+?)(^\\\\\\*\\/$(?:\\r?\\n)?)
      */
@@ -50,32 +52,29 @@ declare module 'tiddlywiki' {
     wikiThemesSubDir: string;
     /** @default './tiddlers' */
     wikiTiddlersSubDir: string;
-    htmlUnsafeElements: string[];
-    [configName: string]: any;
   }
 
   export interface ITiddlyWikiInfoJSON {
-    description: string
-    plugins: string[]
-    themes: string[]
-    languages: any[]
-    build: ITiddlyWikiInfoJSONBuild
-    config: ITiddlyWikiInfoJSONConfig
+    build: ITiddlyWikiInfoJSONBuild;
+    config: ITiddlyWikiInfoJSONConfig;
+    description: string;
+    languages: any[];
+    plugins: string[];
+    themes: string[];
   }
-  
+
   export interface ITiddlyWikiInfoJSONBuild {
-    index: string[]
-    empty: string[]
-    encrypted: string[]
-    favicon: string[]
-    readmes: string[]
-    tw2: string[]
-    static: string[]
-    "external-js": string[]
+    empty: string[];
+    encrypted: string[];
+    'external-js': string[];
+    favicon: string[];
+    index: string[];
+    readmes: string[];
+    static: string[];
+    tw2: string[];
   }
-  
+
   export interface ITiddlyWikiInfoJSONConfig {
-    "retain-original-tiddler-path": boolean
+    'retain-original-tiddler-path': boolean;
   }
-  
 }

package/src/boot/index.d.ts

@@ -20,11 +20,12 @@ declare module 'tiddlywiki' {
 
   export interface IBoot {
     argv: string[];
+    boot: (callback?: () => void) => void;
+    excludeRegExp: RegExp;
     /**
      * Parse any extra plugin references from `$tw.boot.argv[0]` that with `+` prefix.
      */
     extraPlugins: string[];
-    boot: (callback?: () => void) => void;
     files: IBootFilesIndex;
     log: (logString: string) => void;
     logMessages: string[];
@@ -34,7 +35,6 @@ declare module 'tiddlywiki' {
       readBrowserTiddlers: boolean;
       trapErrors: boolean;
     };
-    excludeRegExp: RegExp;
     /** Exist in nodejs wiki, Load the tiddlers from the wiki directory */
     wikiInfo?: ITiddlyWikiInfoJSON;
     /** Exist in nodejs wiki, absolute path of wiki root folder */

package/src/core.d.ts

@@ -9,12 +9,12 @@
 
 declare module 'tiddlywiki' {
   export interface IPluginInfo {
-    version: string;
-    'plugin-type': string;
+    [pluginProperty: string]: string;
     dependents: string;
-    type: 'application/json';
+    'plugin-type': string;
     text: string;
-    [pluginProperty: string]: string;
+    type: 'application/json';
+    version: string;
   }
 
   export interface ILanguage {
@@ -23,99 +23,20 @@ declare module 'tiddlywiki' {
 
   export interface IMacro {
     name: string;
-    params: Array[];
+    params: any[][];
+    // eslint-disable-next-line @typescript-eslint/ban-types
     run: Function;
   }
 
   export type IWikiInfo = Record<string, unknown>;
 
   export interface ITiddlyWiki {
-    Wiki: typeof Wiki;
     Story: typeof Story;
+    Syncer: new() => Syncer;
     Tiddler: typeof Tiddler;
-    syncadaptor?: SyncAdaptor;
-    /**
-     * Presents when we have $tw.syncadaptor
-     */
-    syncer?: Syncer;
-    Syncer: { new (): Syncer };
-
-    wiki: Wiki;
-    boot: IBoot;
-    crypto: Crypto;
-    utils: IUtils;
-    config: IConfig;
-    version: string;
-    safeMode: boolean;
-    modules: IModules;
-    rootWidget: Widget;
-    notifier: Notifier;
-    language: ILanguage;
-    locationHash: string;
-    fakeDocument: IFakeDocument;
-    passwordPrompt: PasswordPrompt;
-    packageInfo: Record<string, unknown>;
-    modal: IModal;
-    keyboardManager: KeyboardManager;
-    macros: Record<string, IMacro>;
-
-    /**
-     * Check for this window being the source of the drag. If true, some drop target widget will stop responding to the drop event, so you can handle drop event in your own widget.
-     * Used by `DropZoneWidget.prototype.handleDropEvent`
-     */
-    dragInProgress?: boolean;
-
-    /**
-     * Global Hooks mechanism which allows plugins to modify default functionality
-     */
-    hooks: IHooks;
-
+    Wiki: typeof Wiki;
     addUnloadTask(task: any);
-
-    /**
-     * Convenience function for pushing a tiddler onto the preloading array.
-     * @param fields - The fields of the tiddler to push.
-     * @description 方便地将一个 tiddler 推入预加载数组中。
-     */
-    preloadTiddler(fields: Record<string, unknown>): void;
-
-    /**
-     * Convenience function for pushing an array of tiddlers onto the preloading array.
-     * @param fieldsArray - The array of tiddlers to push.
-     * @description 方便地将若干 tiddler 数组推入预加载数组中。
-     */
-    preloadTiddlerArray(fieldsArray: Array<Record<string, unknown>>): void;
-
-    /** External JavaScript can populate this array before calling boot.js in order to preload tiddlers */
-    preloadTiddlers: Record<string, Record<string, unknown>>;
-
-    getLibraryItemSearchPaths(libraryPath: string, envVar?: string): string;
-    findLibraryItem(name: string, paths: string[]): string | null;
-    loadPluginFolder(
-      filepath: string,
-      excludeRegExp?: RegExp,
-    ): IPluginInfo | null;
-    loadPlugin(name: string, paths: string[]): void;
-    loadPlugins(plugins: string[], libraryPath: string, envVar?: string): void;
-    loadWikiTiddlers(
-      wikiPath: string,
-      options?: { parentPaths?: string; readOnly?: boolean },
-    ): IWikiInfo;
-    loadTiddlersNode(): void;
-    loadTiddlersBrowser(): void;
-    loadTiddlersFromFile(
-      filepath: string,
-      defaultFields?: Record<string, unknown>,
-    ): ITiddlersInFile;
-    loadMetadataForFile(filepath: string): ITiddlerFields | null;
-    loadTiddlersFromPath(
-      filepath: string,
-      excludeRegExp?: RegExp,
-    ): ITiddlerFields[];
-    loadTiddlersFromSpecification(
-      filepath: string,
-      excludeRegExp?: RegExp,
-    ): ITiddlerFields[];
+    boot: IBoot;
 
     browser: null | {
       is?: {
@@ -154,14 +75,94 @@ declare module 'tiddlywiki' {
        */
       isIE: boolean;
     };
+    config: IConfig;
+    crypto: Crypto;
+    /**
+     * Check for this window being the source of the drag. If true, some drop target widget will stop responding to the drop event, so you can handle drop event in your own widget.
+     * Used by `DropZoneWidget.prototype.handleDropEvent`
+     */
+    dragInProgress?: boolean;
+    fakeDocument: IFakeDocument;
+    findLibraryItem(name: string, paths: string[]): string | null;
+    getLibraryItemSearchPaths(libraryPath: string, environmentVariable?: string): string;
+    /**
+     * Global Hooks mechanism which allows plugins to modify default functionality
+     */
+    hooks: IHooks;
+    keyboardManager: KeyboardManager;
+    language: ILanguage;
+    loadMetadataForFile(filepath: string): ITiddlerFields | null;
+    loadPlugin(name: string, paths: string[]): void;
+    loadPluginFolder(
+      filepath: string,
+      excludeRegExp?: RegExp,
+    ): IPluginInfo | null;
+    loadPlugins(plugins: string[], libraryPath: string, environmentVariable?: string): void;
+    loadTiddlersBrowser(): void;
+    loadTiddlersFromFile(
+      filepath: string,
+      defaultFields?: Record<string, unknown>,
+    ): ITiddlersInFile;
+    loadTiddlersFromPath(
+      filepath: string,
+      excludeRegExp?: RegExp,
+    ): ITiddlerFields[];
+    loadTiddlersFromSpecification(
+      filepath: string,
+      excludeRegExp?: RegExp,
+    ): ITiddlerFields[];
+
+    loadTiddlersNode(): void;
+
+    loadWikiTiddlers(
+      wikiPath: string,
+      options?: { parentPaths?: string; readOnly?: boolean },
+    ): IWikiInfo;
+
+    locationHash: string;
+
+    macros: Record<string, IMacro>;
+
+    modal: IModal;
+
+    modules: IModules;
+
     /** NodeJS features, if tw isn't running on a NodeJS environment, the value will be `null` */
     node: null | Record<string, any>;
     /** Broswer features, if tw isn't running on a browser environment, the value will be `null` */
     nodeWebKit: null | Record<string, any>;
+    notifier: Notifier;
+    packageInfo: Record<string, unknown>;
+    passwordPrompt: PasswordPrompt;
     platform: {
       isLinux: boolean;
       isMac: boolean;
       isWindows: boolean;
     };
+    /**
+     * Convenience function for pushing a tiddler onto the preloading array.
+     * @param fields - The fields of the tiddler to push.
+     * @description 方便地将一个 tiddler 推入预加载数组中。
+     */
+    preloadTiddler(fields: Record<string, unknown>): void;
+    /**
+     * Convenience function for pushing an array of tiddlers onto the preloading array.
+     * @param fieldsArray - The array of tiddlers to push.
+     * @description 方便地将若干 tiddler 数组推入预加载数组中。
+     */
+    preloadTiddlerArray(fieldsArray: Array<Record<string, unknown>>): void;
+    /** External JavaScript can populate this array before calling boot.js in order to preload tiddlers */
+    preloadTiddlers: Record<string, Record<string, unknown>>;
+    rootWidget: Widget;
+    safeMode: boolean;
+    syncadaptor?: SyncAdaptor;
+
+    /**
+     * Presents when we have $tw.syncadaptor
+     */
+    syncer?: Syncer;
+    utils: IUtils;
+    version: string;
+    wiki: Wiki;
   }
 }

package/src/hooks.d.ts

@@ -1,6 +1,5 @@
 declare module 'tiddlywiki' {
   interface IHooks {
-    names: Record<string, Function[]>;
     /** Add hooks to the hashmap */
     addHook(
       hookName: 'th-server-command-post-start',
@@ -12,23 +11,23 @@ declare module 'tiddlywiki' {
     );
     addHook(
       hookName: 'th-saving-tiddler',
-      callback: (toTiddler: Tiddler, fromTiddler: Tiddler) => Tiddler | void,
+      callback: (toTiddler: Tiddler, fromTiddler: Tiddler) => Tiddler | undefined,
     );
     addHook(
       hookName: 'th-renaming-tiddler',
-      callback: (toTiddler: Tiddler, fromTiddler: Tiddler) => Tiddler | void,
+      callback: (toTiddler: Tiddler, fromTiddler: Tiddler) => Tiddler | undefined,
     );
     addHook(
       hookName: 'th-relinking-tiddler',
-      callback: (toTiddler: Tiddler, fromTiddler: Tiddler) => Tiddler | void,
+      callback: (toTiddler: Tiddler, fromTiddler: Tiddler) => Tiddler | undefined,
     );
     addHook(
       hookName: 'th-importing-tiddler',
-      callback: (tiddler: Tiddler) => Tiddler | void,
+      callback: (tiddler: Tiddler) => Tiddler | undefined,
     );
     addHook(
       hookName: 'th-before-importing',
-      callback: (tiddler: Tiddler) => Tiddler | void,
+      callback: (tiddler: Tiddler) => Tiddler | undefined,
     );
     addHook(
       hookName: 'th-opening-default-tiddlers-list',
@@ -68,16 +67,19 @@ declare module 'tiddlywiki' {
     addHook(
       hookName: 'th-importing-file',
       callback: (props: {
-        file: { path?: string, name: string };
-        type: string;
-        isBinary: boolean;
+        // eslint-disable-next-line @typescript-eslint/ban-types
         callback: Function;
-      }) => boolean | void,
+        file: { name: string; path?: string };
+        isBinary: boolean;
+        type: string;
+      }) => boolean | undefined,
     );
     addHook(hookName: string, callback: (...arguments_: unknown[]) => unknown);
     /**
      * Invoke the hook by key
      */
     invokeHook(hookName: string, event: IWidgetEvent): undefined | IWidgetEvent;
+    // eslint-disable-next-line @typescript-eslint/ban-types
+    names: Record<string, Function[]>;
   }
 }

package/src/index.d.ts

@@ -5,7 +5,7 @@ import { ITiddlyWiki } from 'tiddlywiki';
 export * from 'tiddlywiki';
 
 declare module 'tiddlywiki' {
-  export type TW5InitFunction = (baseObject?: Record<string, unknown>) => ITiddlyWiki
+  export type TW5InitFunction = (baseObject?: Record<string, unknown>) => ITiddlyWiki;
   export const TiddlyWiki: TW5InitFunction;
 }
 

package/src/modules/index.d.ts

@@ -26,7 +26,6 @@ declare module 'tiddlywiki' {
   }
   export interface IEvalContent {
     $tw: ITiddlyWiki;
-    // eslint-disable-next-line node/prefer-global/buffer
     Buffer?: Buffer;
     clearInterval: typeof clearInterval;
     clearTimeout: typeof clearTimeout;
@@ -70,13 +69,13 @@ declare module 'tiddlywiki' {
     /** Return a class created from a modules. The module should export the properties to be added to those of the optional base class */
     createClassFromModule: (
       moduleExports: ITWModuleExports,
-      baseClass: new () => unknown,
+      baseClass: new() => unknown,
     ) => ITWModuleExports;
     /** Return an array of classes created from the modules of a specified type. Each module should export the properties to be added to those of the optional base class */
     createClassesFromModules: (
       moduleType: string,
       subType: string | null | undefined,
-      baseClass: new () => unknown,
+      baseClass: new() => unknown,
     ) => Record<string, ITWModuleExports>;
     /**
      * Define a JavaScript tiddler module for later execution

package/src/modules/keyboard.d.ts

@@ -1,49 +1,49 @@
 declare module 'tiddlywiki' {
   // 定义键盘事件信息的接口
   export interface KeyInfo {
-    keyCode: number;
-    shiftKey: boolean;
     altKey: boolean;
     ctrlKey: boolean;
+    keyCode: number;
     metaKey: boolean;
+    shiftKey: boolean;
   }
 
   // 定义键盘管理器类的接口
   export interface KeyboardManager {
-    namedKeys: Record<string, number>;
-    keyNames: string[];
-    metaKeyName: string;
-    shortcutKeysList: string[];
-    shortcutActionList: string[];
-    shortcutParsedList: (KeyInfo[] | undefined)[];
-    shortcutPriorityList: boolean[];
-    lookupNames: string[];
-    getModifierKeys: () => number[];
-    parseKeyDescriptor: (
-      keyDescriptor: string,
-      options?: { keyDescriptor?: string },
-    ) => KeyInfo | null;
-    parseKeyDescriptors: (
-      keyDescriptors: string[] | string,
-      options?: { stack?: string[]; wiki?: any },
-    ) => KeyInfo[];
-    getPrintableShortcuts: (keyInfoArray: KeyInfo[]) => string[];
     checkKeyDescriptor: (event: any, keyInfo: KeyInfo) => boolean;
     checkKeyDescriptors: (event: any, keyInfoArray: KeyInfo[]) => boolean;
+    detectNewShortcuts: (
+      changedTiddlers: Record<string, any>,
+    ) => boolean | string[];
+    getEventModifierKeyDescriptor: (event: any) => string;
     getMatchingKeyDescriptor: (
       event: any,
       keyInfoArray: KeyInfo[],
     ) => KeyInfo | null;
-    getEventModifierKeyDescriptor: (event: any) => string;
+    getModifierKeys: () => number[];
+    getPrintableShortcuts: (keyInfoArray: KeyInfo[]) => string[];
     getShortcutTiddlerList: () => string[];
-    updateShortcutLists: (tiddlerList: string[]) => void;
     handleKeydownEvent: (
       event: any,
       options?: { onlyPriority?: boolean },
     ) => boolean;
-    detectNewShortcuts: (
-      changedTiddlers: Record<string, any>,
-    ) => boolean | string[];
     handleShortcutChanges: (changedTiddlers: Record<string, any>) => void;
+    keyNames: string[];
+    lookupNames: string[];
+    metaKeyName: string;
+    namedKeys: Record<string, number>;
+    parseKeyDescriptor: (
+      keyDescriptor: string,
+      options?: { keyDescriptor?: string },
+    ) => KeyInfo | null;
+    parseKeyDescriptors: (
+      keyDescriptors: string[] | string,
+      options?: { stack?: string[]; wiki?: any },
+    ) => KeyInfo[];
+    shortcutActionList: string[];
+    shortcutKeysList: string[];
+    shortcutParsedList: Array<KeyInfo[] | undefined>;
+    shortcutPriorityList: boolean[];
+    updateShortcutLists: (tiddlerList: string[]) => void;
   }
 }

package/src/modules/parsers/index.d.ts

@@ -4,13 +4,13 @@ declare module 'tiddlywiki' {
      * Optional source uri, used in parseText
      */
     _canonical_uri?: string;
+    defaultType?: string;
+    document?: TWDocument;
+    parentWidget?: Widget;
     /**
      * While calling `getCacheForTiddler`, use inlineParseTree or blockParseTree
      */
     parseAsInline?: boolean;
-    defaultType?: string;
-    parentWidget?: Widget;
-    document?: TWDocument;
   }
 
   export class WikiParseRule {
@@ -35,11 +35,11 @@ declare module 'tiddlywiki' {
     };
   }
   export class WikiParser {
-    blockRules: { matchIndex?: number; rule: WikiParseRule }[];
+    blockRules: Array<{ matchIndex?: number; rule: WikiParseRule }>;
 
-    inlineRules: { matchIndex?: number; rule: WikiParseRule }[];
+    inlineRules: Array<{ matchIndex?: number; rule: WikiParseRule }>;
 
-    pragmaRules: { matchIndex?: number; rule: WikiParseRule }[];
+    pragmaRules: Array<{ matchIndex?: number; rule: WikiParseRule }>;
 
     configTrimWhiteSpace: boolean;
 

package/src/modules/server/index.d.ts

@@ -19,7 +19,7 @@ declare module 'tiddlywiki' {
 
   export interface IServerOptions {
     routes: IRoute[];
-    variables?: { [key: string]: string };
+    variables?: Record<string, string>;
     wiki: Wiki;
   }
 
@@ -104,14 +104,14 @@ declare module 'tiddlywiki' {
   export interface ServerEndpointContext {
     authenticatedUsername: string | undefined;
     data: string;
-    server: Server;
-    wiki: Wiki;
     /**
      * With `exports.path = /^\/recipes\/default\/tiddlers\/(.+)$/;` you can use:
-     * 
+     *
      * `title = $tw.utils.decodeURIComponentSafe(state.params[0])`
      */
     params: string[];
+    server: Server;
+    wiki: Wiki;
   }
   /**
    * @link https://talk.tiddlywiki.org/t/what-is-the-state-in-server-route-handler/2877

package/src/modules/story.d.ts

@@ -5,9 +5,9 @@ declare module 'tiddlywiki' {
     historyTitle: string;
 
     constructor(options?: {
-      wiki?: Wiki;
-      storyTitle?: string;
       historyTitle?: string;
+      storyTitle?: string;
+      wiki?: Wiki;
     });
 
     getStoryList(): string[];

package/src/modules/syncer/syncAdaptor.d.ts

@@ -4,14 +4,11 @@ declare module 'tiddlywiki' {
    * @url https://tiddlywiki.com/dev/#SyncAdaptorModules
    */
   export interface SyncAdaptor {
-    name: string;
-    supportsLazyLoading: boolean;
-    isReady(): boolean;
-    getTiddlerInfo(title: string): IBootFilesIndexItem;
     getTiddlerFileInfo(
       title: string,
       callback: (error: null, fileInfo: IFileInfo) => void,
     ): void;
+    getTiddlerInfo(title: string): IBootFilesIndexItem;
     /**
      * Retrieves the titles of tiddlers that need to be updated from the server.
 
@@ -31,10 +28,13 @@ declare module 'tiddlywiki' {
       deletions: [<array of title>],
       }
       ```
-     * @param syncer 
-     * @param callback 
+     * @param syncer
+     * @param callback
      */
-    getUpdatedTiddlers(syncer: Syncer,callback: (error: Error | null | undefined, changes: { modifications: string[]; deletions: string[] }) => void): void;
+    getUpdatedTiddlers(syncer: Syncer, callback: (error: Error | null | undefined, changes: { deletions: string[]; modifications: string[] }) => void): void;
+    isReady(): boolean;
+    name: string;
+    supportsLazyLoading: boolean;
     wiki: Wiki;
   }
 }