Skip to main content

IHooks

tw5-typed

tw5-typed / hooks / IHooks

Interface: IHooks

Defined in: src/hooks.d.ts:31

Properties​

names​

names: Record<string, (...arguments_) => unknown[]>

Defined in: src/hooks.d.ts:130

Methods​

addHook()​

Call Signature​

addHook(hookName, callback): void

Defined in: src/hooks.d.ts:33

Add hooks to the hashmap

Parameters​
hookName​

"th-server-command-post-start"

callback​

(server, nodeServer, who) => void

Returns​

void

Call Signature​

addHook(hookName, callback): any

Defined in: src/hooks.d.ts:41

Parameters​
hookName​

"th-saving-tiddler" | "th-renaming-tiddler" | "th-relinking-tiddler"

callback​

(toTiddler, fromTiddler) => Tiddler

Returns​

any

Call Signature​

addHook(hookName, callback): any

Defined in: src/hooks.d.ts:45

Parameters​
hookName​

"th-importing-tiddler" | "th-before-importing"

callback​

(tiddler) => Tiddler

Returns​

any

Call Signature​

addHook(hookName, callback): any

Defined in: src/hooks.d.ts:49

Parameters​
hookName​

"th-opening-default-tiddlers-list"

callback​

(storyList) => string[]

Returns​

any

Call Signature​

addHook(hookName, callback): any

Defined in: src/hooks.d.ts:53

Parameters​
hookName​

"th-make-tiddler-path"

callback​

(fullPath, fullPath) => string

Returns​

any

Call Signature​

addHook(hookName, callback): any

Defined in: src/hooks.d.ts:57

Parameters​
hookName​

"th-rendering-element"

callback​

(parseTreeNodes, widget) => parseTreeNodes

Returns​

any

Call Signature​

addHook(hookName, callback): void

Defined in: src/hooks.d.ts:64

Parameters​
hookName​

"th-navigating"

callback​

(event) => NavigatingInfo & IWidgetEvent

Returns​

void

Call Signature​

addHook(hookName, callback): any

Defined in: src/hooks.d.ts:70

Parameters​
hookName​

"th-closing-tiddler" | "th-editing-tiddler" | "th-cancelling-tiddler" | "th-new-tiddler"

callback​

(event) => unknown

Returns​

any

Call Signature​

addHook(hookName, callback): any

Defined in: src/hooks.d.ts:71

Parameters​
hookName​

"th-deleting-tiddler"

callback​

(title) => void

Returns​

any

Call Signature​

addHook(hookName, callback): any

Defined in: src/hooks.d.ts:72

Parameters​
hookName​

"th-page-refreshed" | "th-boot-tiddlers-loaded" | "th-page-refreshing"

callback​

() => void

Returns​

any

Call Signature​

addHook(hookName, callback): any

Defined in: src/hooks.d.ts:73

Parameters​
hookName​

"th-importing-file"

callback​

(props) => boolean

Returns​

any

Call Signature​

addHook(hookName, callback): any

Defined in: src/hooks.d.ts:77

Parameters​
hookName​

string

callback​

(...arguments_) => unknown

Returns​

any

invokeHook()​

invokeHook(hookName, event): IWidgetEvent

Defined in: src/hooks.d.ts:81

Invoke the hook by key

Parameters​

hookName​

string

event​

IWidgetEvent

Returns​

IWidgetEvent

removeHook()​

Call Signature​

removeHook(hookName, callback): void

Defined in: src/hooks.d.ts:85

Remove hooks

Parameters​
hookName​

"th-server-command-post-start"

callback​

(server, nodeServer, who) => void

Returns​

void

Call Signature​

removeHook(hookName, callback): any

Defined in: src/hooks.d.ts:93

Parameters​
hookName​

"th-saving-tiddler" | "th-renaming-tiddler" | "th-relinking-tiddler"

callback​

(toTiddler, fromTiddler) => Tiddler

Returns​

any

Call Signature​

removeHook(hookName, callback): any

Defined in: src/hooks.d.ts:97

Parameters​
hookName​

"th-importing-tiddler" | "th-before-importing"

callback​

(tiddler) => Tiddler

Returns​

any

Call Signature​

removeHook(hookName, callback): any

Defined in: src/hooks.d.ts:101

Parameters​
hookName​

"th-opening-default-tiddlers-list"

callback​

(storyList) => string[]

Returns​

any

Call Signature​

removeHook(hookName, callback): any

Defined in: src/hooks.d.ts:105

Parameters​
hookName​

"th-make-tiddler-path"

callback​

(fullPath, fullPath) => string

Returns​

any

Call Signature​

removeHook(hookName, callback): any

Defined in: src/hooks.d.ts:109

Parameters​
hookName​

"th-rendering-element"

callback​

(parseTreeNodes, widget) => parseTreeNodes

Returns​

any

Call Signature​

removeHook(hookName, callback): void

Defined in: src/hooks.d.ts:116

Parameters​
hookName​

"th-navigating"

callback​

(event) => NavigatingInfo & IWidgetEvent

Returns​

void

Call Signature​

removeHook(hookName, callback): any

Defined in: src/hooks.d.ts:122

Parameters​
hookName​

"th-closing-tiddler" | "th-editing-tiddler" | "th-cancelling-tiddler" | "th-new-tiddler"

callback​

(event) => unknown

Returns​

any

Call Signature​

removeHook(hookName, callback): any

Defined in: src/hooks.d.ts:123

Parameters​
hookName​

"th-deleting-tiddler"

callback​

(title) => void

Returns​

any

Call Signature​

removeHook(hookName, callback): any

Defined in: src/hooks.d.ts:124

Parameters​
hookName​

"th-page-refreshed" | "th-boot-tiddlers-loaded" | "th-page-refreshing"

callback​

() => void

Returns​

any

Call Signature​

removeHook(hookName, callback): any

Defined in: src/hooks.d.ts:125

Parameters​
hookName​

"th-importing-file"

callback​

(props) => boolean

Returns​

any

Call Signature​

removeHook(hookName, callback): any

Defined in: src/hooks.d.ts:129

Parameters​
hookName​

string

callback​

(...arguments_) => unknown

Returns​

any