mirror of https://github.com/Hilbis/Hilbish
docs: [ci] generate new docs
parent
47582e167e
commit
99a121b6fa
|
@ -125,7 +125,10 @@ A call with no argument will toggle the value.
|
||||||
Flush writes all buffered input to the sink.
|
Flush writes all buffered input to the sink.
|
||||||
|
|
||||||
#### read() -> string
|
#### read() -> string
|
||||||
Reads input from the sink.
|
Reads a liine of input from the sink.
|
||||||
|
|
||||||
|
#### readAll() -> string
|
||||||
|
Reads all input from the sink.
|
||||||
|
|
||||||
#### write(str)
|
#### write(str)
|
||||||
Writes data to a sink.
|
Writes data to a sink.
|
||||||
|
|
|
@ -21,6 +21,10 @@ Returns the text that is at the register.
|
||||||
### insert(text)
|
### insert(text)
|
||||||
Inserts text into the line.
|
Inserts text into the line.
|
||||||
|
|
||||||
|
### getChar() -> string
|
||||||
|
Reads a keystroke from the user. This is in a format
|
||||||
|
of something like Ctrl-L.
|
||||||
|
|
||||||
### setVimRegister(register, text)
|
### setVimRegister(register, text)
|
||||||
Sets the vim register at `register` to hold the passed text.
|
Sets the vim register at `register` to hold the passed text.
|
||||||
|
|
||||||
|
|
|
@ -40,6 +40,10 @@ function hilbish.editor.getVimRegister(register) end
|
||||||
--- Inserts text into the line.
|
--- Inserts text into the line.
|
||||||
function hilbish.editor.insert(text) end
|
function hilbish.editor.insert(text) end
|
||||||
|
|
||||||
|
--- Reads a keystroke from the user. This is in a format
|
||||||
|
--- of something like Ctrl-L.
|
||||||
|
function hilbish.editor.getChar() end
|
||||||
|
|
||||||
--- Sets the vim register at `register` to hold the passed text.
|
--- Sets the vim register at `register` to hold the passed text.
|
||||||
--- @param register string
|
--- @param register string
|
||||||
--- @param text string
|
--- @param text string
|
||||||
|
@ -196,10 +200,14 @@ function hilbish:autoFlush(auto) end
|
||||||
--- Flush writes all buffered input to the sink.
|
--- Flush writes all buffered input to the sink.
|
||||||
function hilbish:flush() end
|
function hilbish:flush() end
|
||||||
|
|
||||||
--- Reads input from the sink.
|
--- Reads a liine of input from the sink.
|
||||||
--- @returns string
|
--- @returns string
|
||||||
function hilbish:read() end
|
function hilbish:read() end
|
||||||
|
|
||||||
|
--- Reads all input from the sink.
|
||||||
|
--- @returns string
|
||||||
|
function hilbish:readAll() end
|
||||||
|
|
||||||
--- Writes data to a sink.
|
--- Writes data to a sink.
|
||||||
function hilbish:write(str) end
|
function hilbish:write(str) end
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue