From 33848d81a239e1b651fb29c4233b77d8166425c1 Mon Sep 17 00:00:00 2001 From: sammy-ette Date: Wed, 2 Apr 2025 15:09:38 +0000 Subject: [PATCH] deploy: 04206b6a1445172eb86a59c114be47ce36555a0e --- docs/api/hilbish/hilbish.runner/index.html | 20 ++------------------ 1 file changed, 2 insertions(+), 18 deletions(-) diff --git a/docs/api/hilbish/hilbish.runner/index.html b/docs/api/hilbish/hilbish.runner/index.html index 2e6f343..4778e22 100644 --- a/docs/api/hilbish/hilbish.runner/index.html +++ b/docs/api/hilbish/hilbish.runner/index.html @@ -28,26 +28,10 @@ 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.
exec(cmd, runnerName)Executes cmd with a runner.
set(name, runner)Sets a runner by name. The difference between this function and
get(name)Get a runner by name.
add(name, runner)Adds a runner to the table of available runners.
setCurrent(name)Sets Hilbish’s runner mode by name.
getCurrent()Returns the current runner by name.

hilbish.runner.setMode(cb) +

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.

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 Hilbish’s runner mode by name.

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
Name of the runner

runner function|table

hilbish.runner.get(name) -

Get a runner by name.

Parameters -

name string
Name of the runner to retrieve.

hilbish.runner.set(name, runner) -

Sets a runner by name. The difference between this function and -add, is set will not check if the named runner exists. -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 is not specified, it uses the default Hilbish runner.

Parameters -

cmd string

runnerName string?

Want to help improve this page? Create an issue.

\ No newline at end of file +

string cmd

Want to help improve this page? Create an issue.

\ No newline at end of file