mirror of https://github.com/Hilbis/Hilbish
docs: [ci] generate new docs
parent
42ab856e45
commit
d46c079afb
|
@ -44,6 +44,7 @@ This sink is for writing errors, as the name would suggest.
|
||||||
|----|----|
|
|----|----|
|
||||||
|<a href="#deregister">deregister(name)</a>|Removes the named command. Note that this will only remove Commander-registered commands.|
|
|<a href="#deregister">deregister(name)</a>|Removes the named command. Note that this will only remove Commander-registered commands.|
|
||||||
|<a href="#register">register(name, cb)</a>|Adds a new command with the given `name`. When Hilbish has to run a command with a name,|
|
|<a href="#register">register(name, cb)</a>|Adds a new command with the given `name`. When Hilbish has to run a command with a name,|
|
||||||
|
|<a href="#registry">registry() -> table</a>|Returns all registered commanders. Returns a list of tables with the following keys:|
|
||||||
|
|
||||||
<hr>
|
<hr>
|
||||||
<div id='deregister'>
|
<div id='deregister'>
|
||||||
|
@ -94,3 +95,19 @@ end)
|
||||||
```
|
```
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
<div id='registry'>
|
||||||
|
<h4 class='heading'>
|
||||||
|
commander.registry() -> table
|
||||||
|
<a href="#registry" class='heading-link'>
|
||||||
|
<i class="fas fa-paperclip"></i>
|
||||||
|
</a>
|
||||||
|
</h4>
|
||||||
|
|
||||||
|
Returns all registered commanders. Returns a list of tables with the following keys:
|
||||||
|
- `exec`: The function used to run the commander. Commanders require args and sinks to be passed.
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
This function has no parameters.
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
|
@ -11,4 +11,8 @@ function commander.deregister(name) end
|
||||||
---
|
---
|
||||||
function commander.register(name, cb) end
|
function commander.register(name, cb) end
|
||||||
|
|
||||||
|
--- Returns all registered commanders. Returns a list of tables with the following keys:
|
||||||
|
--- - `exec`: The function used to run the commander. Commanders require args and sinks to be passed.
|
||||||
|
function commander.registry() end
|
||||||
|
|
||||||
return commander
|
return commander
|
||||||
|
|
Loading…
Reference in New Issue