sammyette
/
Hilbish
mirror of https://github.com/Hilbis/Hilbish
2
2
Fork 0
Code Issues Releases Wiki Activity
Hilbish/docs/api/bait.md

32 lines
956 B
Markdown
Raw Normal View History

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 19:08:03 +00:00
---
name: Module bait
docs: push fixed docs
2022-12-03 20:54:34 +00:00
description: the event emitter
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 19:08:03 +00:00
layout: apidoc
---
## Introduction
docs: push fixed docs
2022-12-03 20:54:34 +00:00
Bait is the event emitter for Hilbish. Why name it bait? Why not.
It throws hooks that you can catch. This is what you will use if
you want to listen in on hooks to know when certain things have
happened, like when you've changed directory, a command has failed,
etc. To find all available hooks thrown by Hilbish, see doc hooks.
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 19:08:03 +00:00
## Functions
docs: push fixed docs
2022-12-03 20:54:34 +00:00
### catch(name, cb)
Catches a hook with `name`. Runs the `cb` when it is thrown
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 19:08:03 +00:00
docs: push fixed docs
2022-12-03 20:54:34 +00:00
### catchOnce(name, cb)
Same as catch, but only runs the `cb` once and then removes the hook
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 19:08:03 +00:00
docs: push fixed docs
2022-12-03 20:54:34 +00:00
### hooks(name) -> {cb, cb...}
Returns a table with hooks on the event with `name`.
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 19:08:03 +00:00
docs: push fixed docs
2022-12-03 20:54:34 +00:00
### release(name, catcher)
Removes the `catcher` for the event with `name`
For this to work, `catcher` has to be the same function used to catch
an event, like one saved to a variable.
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 19:08:03 +00:00
docs: push fixed docs
2022-12-03 20:54:34 +00:00
### throw(name, ...args)
Throws a hook with `name` with the provided `args`
refactor: reduce duplication and reorganize code in doc gen
2022-12-03 15:15:25 +00:00