From f07ab5263246d940fbc1d646bcdb5663398378d0 Mon Sep 17 00:00:00 2001 From: Simon Ser Date: Wed, 11 Dec 2019 15:24:39 +0100 Subject: Add docs --- plugin.go | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'plugin.go') diff --git a/plugin.go b/plugin.go index 73f3962..aa964ec 100644 --- a/plugin.go +++ b/plugin.go @@ -8,10 +8,17 @@ import ( const pluginDir = "plugins" +// Plugin extends koushin with additional functionality. type Plugin interface { + // Name should return the plugin name. Name() string + // LoadTemplate populates t with the plugin's functions and templates. LoadTemplate(t *template.Template) error + // SetRoutes populates group with the plugin's routes. SetRoutes(group *echo.Group) + // Inject is called prior to rendering a template. It can extend the + // template data by setting new items in the Extra map. Inject(name string, data interface{}) error + // Close is called when the plugin is unloaded. Close() error } -- cgit v1.2.3-59-g8ed1b