Skip to main content

tw5-typed / core / ITiddlyWiki

Interface: ITiddlyWiki

core.ITiddlyWiki

Table of contents​

Properties​

Methods​

Properties​

Story​

• Story: typeof Story

Defined in​

src/core.d.ts:34

Syncer​

• Syncer: () => Syncer

Type declaration​

• new Syncer(): Syncer

Returns​

Syncer

Defined in​

src/core.d.ts:35

Tiddler​

• Tiddler: typeof Tiddler

Defined in​

src/core.d.ts:36

Wiki​

• Wiki: typeof Wiki

Defined in​

src/core.d.ts:37

boot​

• boot: IBoot

Defined in​

src/core.d.ts:39

browser​

• browser: Object

Type declaration​

NameTypeDescription
is?{ android?: boolean ; bada?: boolean ; blackberry?: boolean ; chrome?: boolean ; firefox?: boolean ; firefoxos?: boolean ; gecko?: boolean ; ios?: boolean ; ipad?: boolean ; iphone?: boolean ; mobile?: boolean ; name?: boolean ; opera?: boolean ; phantomjs?: boolean ; safari?: boolean ; sailfish?: boolean ; seamonkey?: boolean ; silk?: boolean ; tizen?: boolean ; version?: boolean ; webkit?: boolean ; webos?: boolean ; windowsphone?: boolean }-
is.android?boolean-
is.bada?boolean-
is.blackberry?boolean-
is.chrome?boolean-
is.firefox?boolean-
is.firefoxos?boolean-
is.gecko?boolean-
is.ios?boolean-
is.ipad?boolean-
is.iphone?boolean-
is.mobile?boolean-
is.name?boolean-
is.opera?boolean-
is.phantomjs?boolean-
is.safari?boolean-
is.sailfish?boolean-
is.seamonkey?boolean-
is.silk?boolean-
is.tizen?boolean-
is.version?boolean-
is.webkit?boolean-
is.webos?boolean-
is.windowsphone?boolean-
isFirefoxbooleanDeprecated Install $:/plugins/tiddlywiki/browser-sniff to use browser.is
isIEbooleanDeprecated Install $:/plugins/tiddlywiki/browser-sniff to use browser.is

Defined in​

src/core.d.ts:41

config​

• config: IConfig

Defined in​

src/core.d.ts:78

crypto​

• crypto: Crypto

Defined in​

src/core.d.ts:79

dragInProgress​

• Optional dragInProgress: boolean

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

Defined in​

src/core.d.ts:84

fakeDocument​

• fakeDocument: IFakeDocument

Defined in​

src/core.d.ts:85

hooks​

• hooks: IHooks

Global Hooks mechanism which allows plugins to modify default functionality

Defined in​

src/core.d.ts:91

keyboardManager​

• keyboardManager: KeyboardManager

Defined in​

src/core.d.ts:92

language​

• language: ILanguage

Defined in​

src/core.d.ts:93

locationHash​

• locationHash: string

Defined in​

src/core.d.ts:122

macros​

• macros: Record<string, IMacro>

Defined in​

src/core.d.ts:124

modal​

• modal: Modal

Defined in​

src/core.d.ts:126

modules​

• modules: IModules

Defined in​

src/core.d.ts:128

node​

• node: Record<string, any>

NodeJS features, if tw isn't running on a NodeJS environment, the value will be null

Defined in​

src/core.d.ts:131

nodeWebKit​

• nodeWebKit: Record<string, any>

Broswer features, if tw isn't running on a browser environment, the value will be null

Defined in​

src/core.d.ts:133

notifier​

• notifier: Notifier

Defined in​

src/core.d.ts:134

packageInfo​

• packageInfo: Record<string, unknown>

Defined in​

src/core.d.ts:135

passwordPrompt​

• passwordPrompt: PasswordPrompt

Defined in​

src/core.d.ts:136

platform​

• platform: Object

Type declaration​

NameType
isLinuxboolean
isMacboolean
isWindowsboolean

Defined in​

src/core.d.ts:137

preloadTiddlers​

• preloadTiddlers: Record<string, Record<string, unknown>>

External JavaScript can populate this array before calling boot.js in order to preload tiddlers

Defined in​

src/core.d.ts:155

rootWidget​

• rootWidget: widget

Defined in​

src/core.d.ts:156

safeMode​

• safeMode: boolean

Defined in​

src/core.d.ts:157

syncadaptor​

• Optional syncadaptor: SyncAdaptor

Defined in​

src/core.d.ts:158

syncer​

• Optional syncer: Syncer

Presents when we have $tw.syncadaptor

Defined in​

src/core.d.ts:163

utils​

• utils: IUtils

Defined in​

src/core.d.ts:164

version​

• version: string

Defined in​

src/core.d.ts:165

wiki​

• wiki: Wiki

Defined in​

src/core.d.ts:166

Methods​

addUnloadTask​

▸ addUnloadTask(task): any

Parameters​

NameType
taskany

Returns​

any

Defined in​

src/core.d.ts:38

findLibraryItem​

▸ findLibraryItem(name, paths): string

Parameters​

NameType
namestring
pathsstring[]

Returns​

string

Defined in​

src/core.d.ts:86

getLibraryItemSearchPaths​

▸ getLibraryItemSearchPaths(libraryPath, environmentVariable?): string

Parameters​

NameType
libraryPathstring
environmentVariable?string

Returns​

string

Defined in​

src/core.d.ts:87

loadMetadataForFile​

▸ loadMetadataForFile(filepath): ITiddlerFields

Parameters​

NameType
filepathstring

Returns​

ITiddlerFields

Defined in​

src/core.d.ts:94

loadPlugin​

▸ loadPlugin(name, paths): void

Parameters​

NameType
namestring
pathsstring[]

Returns​

void

Defined in​

src/core.d.ts:95

loadPluginFolder​

▸ loadPluginFolder(filepath, excludeRegExp?): IPluginInfo

Parameters​

NameType
filepathstring
excludeRegExp?RegExp

Returns​

IPluginInfo

Defined in​

src/core.d.ts:96

loadPlugins​

▸ loadPlugins(plugins, libraryPath, environmentVariable?): void

Parameters​

NameType
pluginsstring[]
libraryPathstring
environmentVariable?string

Returns​

void

Defined in​

src/core.d.ts:100

loadTiddlersBrowser​

▸ loadTiddlersBrowser(): void

Returns​

void

Defined in​

src/core.d.ts:101

loadTiddlersFromFile​

▸ loadTiddlersFromFile(filepath, defaultFields?): ITiddlersInFile

Parameters​

NameType
filepathstring
defaultFields?Record<string, unknown>

Returns​

ITiddlersInFile

Defined in​

src/core.d.ts:102

loadTiddlersFromPath​

▸ loadTiddlersFromPath(filepath, excludeRegExp?): ITiddlerFields[]

Parameters​

NameType
filepathstring
excludeRegExp?RegExp

Returns​

ITiddlerFields[]

Defined in​

src/core.d.ts:106

loadTiddlersFromSpecification​

▸ loadTiddlersFromSpecification(filepath, excludeRegExp?): ITiddlerFields[]

Parameters​

NameType
filepathstring
excludeRegExp?RegExp

Returns​

ITiddlerFields[]

Defined in​

src/core.d.ts:110

loadTiddlersNode​

▸ loadTiddlersNode(): void

Returns​

void

Defined in​

src/core.d.ts:115

loadWikiTiddlers​

▸ loadWikiTiddlers(wikiPath, options?): IWikiInfo

Parameters​

NameType
wikiPathstring
options?Object
options.parentPaths?string
options.readOnly?boolean

Returns​

IWikiInfo

Defined in​

src/core.d.ts:117

preloadTiddler​

▸ preloadTiddler(fields): void

Convenience function for pushing a tiddler onto the preloading array.

Parameters​

NameTypeDescription
fieldsRecord<string, unknown>The fields of the tiddler to push.

Returns​

void

Description

方便地将一个 tiddler 推入预加载数组中。

Defined in​

src/core.d.ts:147

preloadTiddlerArray​

▸ preloadTiddlerArray(fieldsArray): void

Convenience function for pushing an array of tiddlers onto the preloading array.

Parameters​

NameTypeDescription
fieldsArrayRecord<string, unknown>[]The array of tiddlers to push.

Returns​

void

Description

方便地将若干 tiddler 数组推入预加载数组中。

Defined in​

src/core.d.ts:153