tw5-typed / hooks / IHooks

Interface: IHooks

hooks.IHooks

Table of contents

Properties

• names

Methods

• addHook
• invokeHook

Properties

names

• names: Record<string, Function[]>

Defined in

src/hooks.d.ts:83

Methods

addHook

▸ addHook(hookName, callback): any

Add hooks to the hashmap

Parameters

Name	Type
hookName	"th-server-command-post-start"
callback	(server: unknown, nodeServer: Server, who: "tiddlywiki") => void

Returns

any

Defined in

src/hooks.d.ts:4

▸ addHook(hookName, callback): any

Parameters

Name	Type
hookName	"th-saving-tiddler"
callback	(toTiddler: Tiddler, fromTiddler: Tiddler) => void | Tiddler

Returns

any

Defined in

src/hooks.d.ts:12

▸ addHook(hookName, callback): any

Parameters

Name	Type
hookName	"th-renaming-tiddler"
callback	(toTiddler: Tiddler, fromTiddler: Tiddler) => void | Tiddler

Returns

any

Defined in

src/hooks.d.ts:16

▸ addHook(hookName, callback): any

Parameters

Name	Type
hookName	"th-relinking-tiddler"
callback	(toTiddler: Tiddler, fromTiddler: Tiddler) => void | Tiddler

Returns

any

Defined in

src/hooks.d.ts:20

▸ addHook(hookName, callback): any

Parameters

Name	Type
hookName	"th-importing-tiddler"
callback	(tiddler: Tiddler) => void | Tiddler

Returns

any

Defined in

src/hooks.d.ts:24

▸ addHook(hookName, callback): any

Parameters

Name	Type
hookName	"th-before-importing"
callback	(tiddler: Tiddler) => void | Tiddler

Returns

any

Defined in

src/hooks.d.ts:28

▸ addHook(hookName, callback): any

Parameters

Name	Type
hookName	"th-opening-default-tiddlers-list"
callback	(storyList: string[]) => string[]

Returns

any

Defined in

src/hooks.d.ts:32

▸ addHook(hookName, callback): any

Parameters

Name	Type
hookName	"th-make-tiddler-path"
callback	(fullPath: string, fullPath: string) => string

Returns

any

Defined in

src/hooks.d.ts:36

▸ addHook(hookName, callback): any

Parameters

Name	Type
hookName	"th-rendering-element"
callback	(parseTreeNodes: IParseTreeNode, widget: widget) => parseTreeNodes

Returns

any

Defined in

src/hooks.d.ts:40

▸ addHook(hookName, callback): any

Parameters

Name	Type
hookName	"th-navigating"
callback	(event: unknown) => unknown

Returns

any

Defined in

src/hooks.d.ts:47

▸ addHook(hookName, callback): any

Parameters

Name	Type
hookName	"th-closing-tiddler"
callback	(event: unknown) => unknown

Returns

any

Defined in

src/hooks.d.ts:48

▸ addHook(hookName, callback): any

Parameters

Name	Type
hookName	"th-editing-tiddler"
callback	(event: unknown) => unknown

Returns

any

Defined in

src/hooks.d.ts:52

▸ addHook(hookName, callback): any

Parameters

Name	Type
hookName	"th-cancelling-tiddler"
callback	(event: unknown) => unknown

Returns

any

Defined in

src/hooks.d.ts:56

▸ addHook(hookName, callback): any

Parameters

Name	Type
hookName	"th-new-tiddler"
callback	(event: unknown) => unknown

Returns

any

Defined in

src/hooks.d.ts:60

▸ addHook(hookName, callback): any

Parameters

Name	Type
hookName	"th-deleting-tiddler"
callback	(title: string) => void

Returns

any

Defined in

src/hooks.d.ts:61

▸ addHook(hookName, callback): any

Parameters

Name	Type
hookName	"th-page-refreshed"
callback	() => void

Returns

any

Defined in

src/hooks.d.ts:62

▸ addHook(hookName, callback): any

Parameters

Name	Type
hookName	"th-boot-tiddlers-loaded"
callback	() => void

Returns

any

Defined in

src/hooks.d.ts:63

▸ addHook(hookName, callback): any

Parameters

Name	Type
hookName	"th-page-refreshed"
callback	() => void

Returns

any

Defined in

src/hooks.d.ts:64

▸ addHook(hookName, callback): any

Parameters

Name	Type
hookName	"th-page-refreshing"
callback	() => void

Returns

any

Defined in

src/hooks.d.ts:65

▸ addHook(hookName, callback): any

Parameters

Name	Type
hookName	"th-page-refreshed"
callback	() => void

Returns

any

Defined in

src/hooks.d.ts:66

▸ addHook(hookName, callback): any

Parameters

Name	Type
hookName	"th-importing-file"
callback	(props: { callback: Function ; file: { name: string ; path?: string } ; isBinary: boolean ; type: string }) => boolean | void

Returns

any

Defined in

src/hooks.d.ts:67

▸ addHook(hookName, callback): any

Parameters

Name	Type
hookName	string
callback	(...arguments_: unknown[]) => unknown

Returns

any

Defined in

src/hooks.d.ts:77

---

invokeHook

▸ invokeHook(hookName, event): void | IWidgetEvent

Invoke the hook by key

Parameters

Name	Type
hookName	string
event	IWidgetEvent

Returns

void | IWidgetEvent

Defined in

src/hooks.d.ts:81