sammyette/Hilbish
2
2
Fork 0
mirror of https://github.com/Hilbis/Hilbish synced 2025-04-27 07:53:23 +00:00
Code Issues Releases Wiki Activity
Hilbish/docs/hooks/index.md
TorchedSammy 1b24e91597
feat!: enhance docs and doc command 
changes the actual file format of docs
to markup since that's basically what we have been
using in the first place.

the docgen command has been modified to write
markdown headings with the function name and
yaml metadata for easy consumption by hugo for the
website (soon).

all other docs have been moved to markdown as well
this is the main reason this is a "breaking" change
users will have to reinstall hilbish
(task uninstall and task install) to remove the old
plaintext docs
2022-12-02 15:08:03 -04:00

589 B
Raw Permalink Blame History

Here is a list of bait hooks that are thrown by Hilbish. If a hook is related to a command, it will have the command scope, as example.

Here is the format for a doc for a hook:

  • -> >

<args> just means the arguments of the hook. If a hook doc has the format of arg..., it means the hook can take/recieve any number of arg.

  • error -> eventName, handler, err > Emitted when there is an error in an event handler. The eventName is the name of the event the handler is for, the handler is the callback function, and err is the error message.