mirror of https://github.com/Hilbis/Hilbish
68 lines
1.9 KiB
Markdown
68 lines
1.9 KiB
Markdown
---
|
|
title: Module commander
|
|
description: library for custom commands
|
|
layout: doc
|
|
menu:
|
|
docs:
|
|
parent: "API"
|
|
---
|
|
|
|
## Introduction
|
|
|
|
Commander is a library for writing custom commands in Lua.
|
|
In order to make it easier to write commands for Hilbish,
|
|
not require separate scripts and to be able to use in a config,
|
|
the Commander library exists. This is like a very simple wrapper
|
|
that works with Hilbish for writing commands. Example:
|
|
|
|
```lua
|
|
local commander = require 'commander'
|
|
|
|
commander.register('hello', function(args, sinks)
|
|
sinks.out:writeln 'Hello world!'
|
|
end)
|
|
```
|
|
|
|
In this example, a command with the name of `hello` is created
|
|
that will print `Hello world!` to output. One question you may
|
|
have is: What is the `sinks` parameter?
|
|
|
|
The `sinks` parameter is a table with 3 keys: `in`, `out`,
|
|
and `err`. The values of these is a <a href="/Hilbish/docs/api/hilbish/#sink" style="text-decoration: none;">Sink</a>.
|
|
|
|
- `in` is the standard input. You can read from this sink
|
|
to get user input. (**This is currently unimplemented.**)
|
|
- `out` is standard output. This is usually where text meant for
|
|
output should go.
|
|
- `err` is standard error. This sink is for writing errors, as the
|
|
name would suggest.
|
|
|
|
## Functions
|
|
|||
|
|
|----|----|
|
|
|<a href="#deregister">deregister(name)</a>|Deregisters any command registered with `name`|
|
|
|<a href="#register">register(name, cb)</a>|Register a command with `name` that runs `cb` when ran|
|
|
|
|
<hr><div id='deregister'>
|
|
<h4 class='heading'>
|
|
commander.deregister(name)
|
|
<a href="#deregister" class='heading-link'>
|
|
<i class="fas fa-paperclip"></i>
|
|
</a>
|
|
</h4>
|
|
|
|
Deregisters any command registered with `name`
|
|
#### Parameters
|
|
This function has no parameters.
|
|
</div><hr><div id='register'>
|
|
<h4 class='heading'>
|
|
commander.register(name, cb)
|
|
<a href="#register" class='heading-link'>
|
|
<i class="fas fa-paperclip"></i>
|
|
</a>
|
|
</h4>
|
|
|
|
Register a command with `name` that runs `cb` when ran
|
|
#### Parameters
|
|
This function has no parameters.
|
|
</div> |