mirror of https://github.com/Hilbis/Hilbish
docs: [ci] generate new docs
parent
a77b997942
commit
0bf4072355
|
@ -3,12 +3,18 @@
|
||||||
local bait = {}
|
local bait = {}
|
||||||
|
|
||||||
--- Catches a hook with `name`. Runs the `cb` when it is thrown
|
--- Catches a hook with `name`. Runs the `cb` when it is thrown
|
||||||
function bait.catch() end
|
--- @param name string
|
||||||
|
--- @param cb function
|
||||||
|
function bait.catch(name, cb) end
|
||||||
|
|
||||||
--- Same as catch, but only runs the `cb` once and then removes the hook
|
--- Same as catch, but only runs the `cb` once and then removes the hook
|
||||||
function bait.catchOnce() end
|
--- @param name string
|
||||||
|
--- @param cb function
|
||||||
|
function bait.catchOnce(name, cb) end
|
||||||
|
|
||||||
--- Throws a hook with `name` with the provided `args`
|
--- Throws a hook with `name` with the provided `args`
|
||||||
function bait.throw() end
|
--- @param name string
|
||||||
|
--- @vararg any
|
||||||
|
function bait.throw(name) end
|
||||||
|
|
||||||
return bait
|
return bait
|
||||||
|
|
|
@ -3,9 +3,12 @@
|
||||||
local commander = {}
|
local commander = {}
|
||||||
|
|
||||||
--- Deregisters any command registered with `name`
|
--- Deregisters any command registered with `name`
|
||||||
function commander.deregister() end
|
--- @param name string
|
||||||
|
function commander.deregister(name) end
|
||||||
|
|
||||||
--- Register a command with `name` that runs `cb` when ran
|
--- Register a command with `name` that runs `cb` when ran
|
||||||
function commander.register() end
|
--- @param name string
|
||||||
|
--- @param cb function
|
||||||
|
function commander.register(name, cb) end
|
||||||
|
|
||||||
return commander
|
return commander
|
||||||
|
|
|
@ -3,15 +3,21 @@
|
||||||
local fs = {}
|
local fs = {}
|
||||||
|
|
||||||
--- Changes directory to `dir`
|
--- Changes directory to `dir`
|
||||||
function fs.cd() end
|
--- @param dir string
|
||||||
|
function fs.cd(dir) end
|
||||||
|
|
||||||
--- Makes a directory called `name`. If `recursive` is true, it will create its parent directories.
|
--- Makes a directory called `name`. If `recursive` is true, it will create its parent directories.
|
||||||
function fs.mkdir() end
|
--- @param name string
|
||||||
|
--- @param recursive bool
|
||||||
|
function fs.mkdir(name, recursive) end
|
||||||
|
|
||||||
--- Returns a table of files in `dir`
|
--- Returns a table of files in `dir`
|
||||||
function fs.readdir() end
|
--- @param dir string
|
||||||
|
--- @return table
|
||||||
|
function fs.readdir(dir) end
|
||||||
|
|
||||||
--- Returns info about `path`
|
--- Returns info about `path`
|
||||||
function fs.stat() end
|
--- @param path string
|
||||||
|
function fs.stat(path) end
|
||||||
|
|
||||||
return fs
|
return fs
|
||||||
|
|
Loading…
Reference in New Issue