diff --git a/docs/api/bait/index.html b/docs/api/bait/index.html index 5f2d700..dfd09f6 100644 --- a/docs/api/bait/index.html +++ b/docs/api/bait/index.html @@ -6,6 +6,6 @@ Hilbish It throws hooks that you can catch. This is what you will use if you want to listen in on hooks to know when certain things have happened, like when you’ve changed directory, a command has failed, -etc. To find all available hooks thrown by Hilbish, see doc hooks.

Functions

catch(name, cb)

Catches a hook with name. Runs the cb when it is thrown

catchOnce(name, cb)

Same as catch, but only runs the cb once and then removes the hook

hooks(name) -> {cb, cb…}

Returns a table with hooks on the event with name.

release(name, catcher)

Removes the catcher for the event with name +etc. To find all available hooks thrown by Hilbish, see doc hooks.

Functions

catch(name, cb)

Catches a hook with name. Runs the cb when it is thrown

catchOnce(name, cb)

Same as catch, but only runs the cb once and then removes the hook

hooks(name) ->

Returns a table with hooks (callback functions) on the event with name.

release(name, catcher)

Removes the catcher for the event with name For this to work, catcher has to be the same function used to catch an event, like one saved to a variable.

throw(name, …args)

Throws a hook with name with the provided args

Want to help improve this page? Create an issue.

\ No newline at end of file diff --git a/docs/api/fs/index.html b/docs/api/fs/index.html index 84fba03..c05202a 100644 --- a/docs/api/fs/index.html +++ b/docs/api/fs/index.html @@ -7,5 +7,10 @@ and other things, and acts an addition to the Lua standard library’s I/O and filesystem functions.

Functions

abs(path)

Gives an absolute version of path.

basename(path)

Gives the basename of path. For the rules, see Go’s filepath.Base

cd(dir)

Changes directory to dir

dir(path)

Returns the directory part of path. For the rules, see Go’s filepath.Dir

glob(pattern)

Glob all files and directories that match the pattern. -For the rules, see Go’s filepath.Glob

join(paths…)

Takes paths and joins them together with the OS’s -directory separator (forward or backward slash).

mkdir(name, recursive)

Makes a directory called name. If recursive is true, it will create its parent directories.

readdir(dir)

Returns a table of files in dir

stat(path)

Returns info about path

Want to help improve this page? Create an issue.

\ No newline at end of file +For the rules, see Go’s filepath.Glob

join(…)

Takes paths and joins them together with the OS’s +directory separator (forward or backward slash).

mkdir(name, recursive)

Makes a directory called name. If recursive is true, it will create its parent directories.

readdir(dir) ->

Returns a table of files in dir.

stat(path) ->

Returns a table of info about the path. +It contains the following keys: +name (string) - Name of the path +size (number) - Size of the path +mode (string) - Permission mode in an octal format string (with leading 0) +isDir (boolean) - If the path is a directory

Want to help improve this page? Create an issue.

\ No newline at end of file