From f309fb34875553d46ef9954a7e297afbee237851 Mon Sep 17 00:00:00 2001 From: TorchedSammy Date: Tue, 7 Feb 2023 19:40:13 +0000 Subject: [PATCH] deploy: 61914f8dc73d64e6e3b7d88d3a18b7dde43edb49 --- docs/api/commander/index.html | 8 +++----- docs/api/hilbish/index.html | 8 +++++++- 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/docs/api/commander/index.html b/docs/api/commander/index.html index b599332b..016255f2 100644 --- a/docs/api/commander/index.html +++ b/docs/api/commander/index.html @@ -14,13 +14,11 @@ that works with Hilbish for writing commands. Example:

< 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?

A sink is a writable/readable pipe, or you can imagine a Lua -file. It’s used in this case to write to the proper output, -incase a user either pipes to another command or redirects somewhere else.

So, the sinks parameter is a table containing 3 sinks: -in, out, and err.

Functions

deregister(name)

Deregisters any command registered with name

register(name, cb)

Register a command with name that runs cb when ran

Want to help improve this page? Create an issue.

\ No newline at end of file diff --git a/docs/api/hilbish/index.html b/docs/api/hilbish/index.html index c104df3b..648606e8 100644 --- a/docs/api/hilbish/index.html +++ b/docs/api/hilbish/index.html @@ -51,4 +51,10 @@ will call it to execute user input instead.

Runs the cb function after time in milliseconds. This creates a timer that starts immediately.

which(name) -> string

Checks if name is a valid command. -Will return the path of the binary, or a basename if it’s a commander.

Want to help improve this page? Create an issue.

\ No newline at end of file +Will return the path of the binary, or a basename if it’s a commander.

Types +

Sink +

A sink is a structure that has input and/or output to/from +a desination.

Methods +

write(str) +

Writes data to a sink.

writeln(str) +

Writes data to a sink with a newline at the end.

Want to help improve this page? Create an issue.

\ No newline at end of file