2
2
mirror of https://github.com/Hilbis/Hilbish synced 2025-07-11 05:22:02 +00:00
Hilbish/docs/api/hilbish/hilbish.editor.md
sammyette 7c1984135b
docs: add detailed parameter listing, change interface to modules
there are a few changes here
- documentation of each parameter separately has been added
to the generated text docs
- interfaces have been renamed to modules. this was honestly a pointless
and confusing distinction (interfaces are tables for modules that are
lua modules). it also makes it so that (formerly) interfaces and
modules line up with each other on the doc list

im not sure what else i did, these are old changes
2023-08-26 11:30:51 -04:00

808 B

title description layout menu
Module hilbish.editor interactions for Hilbish's line reader doc
docs
parent
API

Introduction

The hilbish.editor interface provides functions to directly interact with the line editor in use.

Functions

hilbish.editor.getLine() -> string

Returns the current input line.

Parameters

This function has no parameters.

hilbish.editor.getVimRegister(register) -> string

Returns the text that is at the register.

Parameters

This function has no parameters.

hilbish.editor.insert(text)

Inserts text into the line.

Parameters

This function has no parameters.

hilbish.editor.setVimRegister(register, text)

Sets the vim register at register to hold the passed text.

Parameters

This function has no parameters.