From 1ce9db9dec34a3c3d0089e4d2279ad8a82e72b38 Mon Sep 17 00:00:00 2001 From: TorchedSammy Date: Sun, 12 Jan 2025 21:53:32 +0000 Subject: [PATCH] deploy: eea124ca32b4a0eb60916d0f3bbe0db65562216f --- .../api/hilbish/hilbish.runner/index.html | 35 ++++++++++--------- 1 file changed, 19 insertions(+), 16 deletions(-) diff --git a/versions/document-lua/docs/api/hilbish/hilbish.runner/index.html b/versions/document-lua/docs/api/hilbish/hilbish.runner/index.html index 5a9ccf3..93479bf 100644 --- a/versions/document-lua/docs/api/hilbish/hilbish.runner/index.html +++ b/versions/document-lua/docs/api/hilbish/hilbish.runner/index.html @@ -28,24 +28,27 @@ shell script if fennel eval has an error.

11	return hilbish.runner.sh(input)
 12end)

Functions -

setMode(cb)This is the same as the hilbish.runnerMode function.
lua(cmd)Evaluates cmd as Lua input. This is the same as using dofile
sh(cmd)Runs a command in Hilbish’s shell script interpreter.
getCurrent()Returns the current runner by name.
setCurrent(name)Sets the current interactive/command line runner mode.
add(name, runner)Adds a runner to the table of available runners. If runner is a table,
get(name)Get a runner by name.
set(name, runner)Sets a runner by name. The runner table must have the run function in it.
exec(cmd, runnerName)Executes cmd with a runner. If runnerName isn’t passed, it uses
d)

Evaluates cmd as Lua input. This is the same as using dofile
or load, but is appropriated for the runner interface.

Parameters -

string cmd

hilbish.runner.sh(cmd) -

Runs a command in Hilbish’s shell script interpreter.
This is the equivalent of using source.

Parameters -

string cmd

hilbish.runner.getCurrent() -

Returns the current runner by name.

Parameters -

This function has no parameters.

hilbish.runner.setCurrent(name) -

Sets the current interactive/command line runner mode.

Parameters -

name string

hilbish.runner.add(name, runner) +

setMode(cb)This is the same as the hilbish.runnerMode function.
lua(cmd)Evaluates cmd as Lua input. This is the same as using dofile
sh(cmd)Runs a command in Hilbish’s shell script interpreter.
exec(cmd, runnerName)Executes cmd with a runner. If runnerName isn’t passed, it uses
set(name, runner)Sets a runner by name. The runner table must have the run function in it.
get(name)Get a runner by name.
add(name, runner)Adds a runner to the table of available runners. If runner is a table,
setCurrent(name)Sets the current interactive/command line runner mode.
getCurrent()Returns the current runner by name.

hilbish.runner.setMode(cb) +

This is the same as the hilbish.runnerMode function.
It takes a callback, which will be used to execute all interactive input.
In normal cases, neither callbacks should be overrided by the user,
as the higher level functions listed below this will handle it.

Parameters +

function cb

hilbish.runner.lua(cmd) +

Evaluates cmd as Lua input. This is the same as using dofile
or load, but is appropriated for the runner interface.

Parameters +

string cmd

hilbish.runner.sh(cmd) +

Runs a command in Hilbish’s shell script interpreter.
This is the equivalent of using source.

Parameters +

string cmd

hilbish.runner.getCurrent() +

Returns the current runner by name.

Parameters +

This function has no parameters.

hilbish.runner.setCurrent(name) +

Sets the current interactive/command line runner mode.

Parameters +

name string

hilbish.runner.add(name, runner)

Adds a runner to the table of available runners. If runner is a table, -it must have the run function in it.

Parameters -

name string +it must have the run function in it.

Parameters +

name string runner function

hilbish.runner.get(name) -

Get a runner by name.

Parameters -

name string

hilbish.runner.set(name, runner) -

Sets a runner by name. The runner table must have the run function in it.

Parameters -

name string +

Get a runner by name.

Parameters +

name string

hilbish.runner.set(name, runner) +

Sets a runner by name. The runner table must have the run function in it.

Parameters +

name string runner table

hilbish.runner.exec(cmd, runnerName)

Executes cmd with a runner. If runnerName isn’t passed, it uses -the user’s current runner.

Parameters -

cmd string +the user’s current runner.

Parameters +

cmd string runnerName string?

Want to help improve this page? Create an issue.

\ No newline at end of file