dan/koa-plugins
1
0
Fork 0
mirror of https://github.com/danbulant/koa-plugins synced 2026-05-19 04:08:43 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add gitignore

Browse source
This commit is contained in:
Daniel Bulant 2020-03-01 18:04:10 +01:00
parent 5ed8a8a259
commit bd46585c40
2 changed files with 6 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
.gitignore vendored Normal file
View file

@ -0,0 +1,4 @@
node_modules
node_modules/*
node_modules/
.ssh

2
README.md
View file

@ -12,6 +12,7 @@ Easy plugins is based on Koa, so the ctx variable that's passed is koa's context
The plugin must export object or function. Object should contain these:
| enabled | Whether the plugin is enabled and should be used |
| ---- | ---- |
| exec | Function to call when plugin is enabled and request matches rules |
| rules | Object containing rules to be passed before calling exec. Can be function, in which case the context is passed and must return boolean (or Promise<boolean>). If empty, automatically evaluates to true.|
@ -20,6 +21,7 @@ If the exported is function, it works as `multi-plugin`:
The function gets parameter `hooks` which is a class for managing plugins. Then it should call function `hooks.registerPlugin` with the following parameters:
| exec | Function to call when request rules matches |
| ---- | ---- |
| rules | *optional*, same as in object plugin |
### Rules