aboutsummaryrefslogtreecommitdiffstats
path: root/README.hooks
diff options
context:
space:
mode:
Diffstat (limited to 'README.hooks')
-rw-r--r--README.hooks24
1 files changed, 24 insertions, 0 deletions
diff --git a/README.hooks b/README.hooks
new file mode 100644
index 0000000..d15949c
--- /dev/null
+++ b/README.hooks
@@ -0,0 +1,24 @@
+Hooks that plugins can provide
+
+All hooks must return either undefined/null or a list of return values. This might be an empty list or a list of just one value.
+
+handlePath
+ Registers new urls to serve
+ Parameters: None
+ Returns: Parameter suitable for Dispatcher
+renderPageBodyPre
+ Adds extra html before the body of a page
+ Parameters: bodyFileName, data, plugin
+ Returns: String(s) of html
+renderPageBodyPost
+ Adds extra html after the body of a page
+ Parameters: bodyFileName, data, plugin
+ Returns: String(s) of html
+serverStartup
+ Run right after server startup
+ Parameters: None
+ Returns: None
+serverShutdown
+ Run before server shutdown
+ Parameters: None
+ Returns: None