sammyette
/
Hilbish
mirror of https://github.com/Hilbis/Hilbish
2
2
Fork 0
Code Issues Releases Wiki Activity

docs: [ci] generate new docs

fuzzy-history-search
TorchedSammy 2023-03-25 21:42:46 +00:00 committed by github-actions[bot]
parent d577b3c958
commit 0379e302ac
2 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/api/hilbish/_index.md
View File

@ -109,6 +109,16 @@ A sink is a structure that has input and/or output to/from
a desination.
### Methods
#### autoFlush(auto)
Sets/toggles the option of automatically flushing output.
A call with no argument will toggle the value.
#### flush()
Flush writes all buffered input to the sink.
#### read() -> string
Reads input from the sink.
#### write(str)
Writes data to a sink.

12
emmyLuaDocs/hilbish.lua
View File

@ -180,6 +180,18 @@ function hilbish.jobs:foreground() end
--- @param cmd string
function hilbish.runner.lua(cmd) end
--- Sets/toggles the option of automatically flushing output.
--- A call with no argument will toggle the value.
--- @param auto boolean|nil
function hilbish:autoFlush(auto) end
--- Flush writes all buffered input to the sink.
function hilbish:flush() end
--- Reads input from the sink.
--- @returns string
function hilbish:read() end
--- Writes data to a sink.
function hilbish:write(str) end