1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-01 07:36:18 +00:00
TiddlyWiki5/editions/dev/tiddlers/new/Hook__th-server-command-post-start.tid
Arlen22 603c564872 Add the "tiddlywiki" argument to the server start hook (#3592)
* Update Hook__th-server-command-post-start.tid

* Update server.js

* Update listen.js
2018-11-29 09:51:11 +00:00

21 lines
837 B
Plaintext

created: 20180409142128584
modified: 20180409142128584
tags: HookMechanism
title: Hook: th-server-command-post-start
type: text/vnd.tiddlywiki
This hook allows plugins to extend the TiddlyWiki server command after it initializes. The two
most obvious use cases are adding routes (such as an attachments folder for external files)
to the SimpleServer instance and adding a websockets handler to the HTTP server.
Hook function parameters:
* SimpleServer instance
** Defined in core/modules/commands/server.js
* NodeJS HTTP Server instance
** See the NodeJS docs at [ext[https://nodejs.org/docs/latest-v8.x/api/http.html#http_class_http_server]]
* Name of server invoking this hook (for special handling of the NodeJS HTTP server instance argument).
** Current known values: `tiddlywiki`, `tiddlyserver`.
Return value is ignored.