Skip to main content

IBoot

tw5-typed

tw5-typed / boot / IBoot

Interface: IBoot

Defined in: src/boot/index.d.ts:48

Properties​

argv​

argv: string[]

Defined in: src/boot/index.d.ts:49

boot()​

boot: (callback?) => void

Defined in: src/boot/index.d.ts:50

Parameters​

callback?​

() => void

Returns​

void

bootPath?​

optional bootPath: string

Defined in: src/boot/index.d.ts:52

Absolute path to the boot directory (Node.js only)

corePath?​

optional corePath: string

Defined in: src/boot/index.d.ts:54

Absolute path to the core directory (Node.js only)

coreServerPath?​

optional coreServerPath: string

Defined in: src/boot/index.d.ts:56

Absolute path to the core-server directory (Node.js only)

decryptEncryptedTiddlers()​

decryptEncryptedTiddlers: (callback) => void

Defined in: src/boot/index.d.ts:57

Parameters​

callback​

() => void

Returns​

void

disabledStartupModules?​

optional disabledStartupModules: string[]

Defined in: src/boot/index.d.ts:58

doesTaskMatchPlatform()​

doesTaskMatchPlatform: (taskModule) => boolean

Defined in: src/boot/index.d.ts:59

Parameters​

taskModule​

unknown

Returns​

boolean

excludeRegExp​

excludeRegExp: RegExp

Defined in: src/boot/index.d.ts:60

execStartup()​

execStartup: (options) => void

Defined in: src/boot/index.d.ts:61

Parameters​

options​

IStartUpOption

Returns​

void

extraPlugins​

extraPlugins: string[]

Defined in: src/boot/index.d.ts:65

Parse any extra plugin references from $tw.boot.argv[0] that with + prefix.

files​

files: IBootFilesIndex

Defined in: src/boot/index.d.ts:66

initStartup()​

initStartup: (options) => void

Defined in: src/boot/index.d.ts:67

Parameters​

options​

IStartUpOption

Returns​

void

isStartupTaskEligible()​

isStartupTaskEligible: (taskModule) => boolean

Defined in: src/boot/index.d.ts:68

Parameters​

taskModule​

unknown

Returns​

boolean

loadStartup()​

loadStartup: (options) => void

Defined in: src/boot/index.d.ts:69

Parameters​

options​

IStartUpOption

Returns​

void

log()​

log: (logString) => void

Defined in: src/boot/index.d.ts:70

Parameters​

logString​

string

Returns​

void

logMessages​

logMessages: string[]

Defined in: src/boot/index.d.ts:71

remainingStartupModules?​

optional remainingStartupModules: unknown[]

Defined in: src/boot/index.d.ts:72

startup()​

startup: (options) => void

Defined in: src/boot/index.d.ts:73

Parameters​

options​

IStartUpOption

Returns​

void

tasks​

tasks: object

Defined in: src/boot/index.d.ts:75

Default boot tasks

readBrowserTiddlers​

readBrowserTiddlers: boolean

trapErrors​

trapErrors: boolean

wikiInfo?​

optional wikiInfo: ITiddlyWikiInfoJSON

Defined in: src/boot/index.d.ts:80

Exist in nodejs wiki, Load the tiddlers from the wiki directory

wikiPath?​

optional wikiPath: string

Defined in: src/boot/index.d.ts:82

Exist in nodejs wiki, absolute path of wiki root folder

wikiTiddlersPath?​

optional wikiTiddlersPath: string

Defined in: src/boot/index.d.ts:84

Exist in nodejs wiki, usually is ./tiddlers