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

74 lines
1.7 KiB
Markdown
Raw Normal View History

refactor!: rework docs and doc command (#218) changes the actual file format of docs to markup since that's basically what we have been using in the first place. the docgen command has been modified to write markdown headings with the function name and yaml metadata for easy consumption by hugo for the website. all other docs have been moved to markdown as well this is the main reason this is a "breaking" change users will have to reinstall hilbish (task uninstall and task install) to remove the old plaintext docs
2022-12-15 04:00:54 +00:00
---
title: Module terminal
description: low level terminal library
layout: doc
menu:
docs:
parent: "API"
---
## Introduction
The terminal library is a simple and lower level library for certain terminal interactions.
## Functions
docs: make various style changes - add a table that lists module functions - add highlight when jumping to a function - separators
2023-09-02 18:18:40 +00:00
|||
|----|----|
|<a href="#restoreState">restoreState()</a>|Restores the last saved state of the terminal|
|<a href="#saveState">saveState()</a>|Saves the current state of the terminal|
|<a href="#setRaw">setRaw()</a>|Puts the terminal in raw mode|
|<a href="#size">size()</a>|Gets the dimensions of the terminal. Returns a table with `width` and `height`|
<hr><div id='restoreState'>
<h4 class='heading'>
terminal.restoreState()
<a href="#restoreState" class='heading-link'>
<i class="fas fa-paperclip"></i>
</a>
</h4>
chore: update docs
2023-12-02 12:23:49 +00:00
Restores the last saved state of the terminal
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 15:30:51 +00:00
#### Parameters
This function has no parameters.
docs: turn properties list into a table also fix member functions causing a spam of separators
2023-09-02 20:01:57 +00:00
</div>
<hr><div id='saveState'>
docs: make various style changes - add a table that lists module functions - add highlight when jumping to a function - separators
2023-09-02 18:18:40 +00:00
<h4 class='heading'>
terminal.saveState()
<a href="#saveState" class='heading-link'>
<i class="fas fa-paperclip"></i>
</a>
</h4>
refactor!: rework docs and doc command (#218) changes the actual file format of docs to markup since that's basically what we have been using in the first place. the docgen command has been modified to write markdown headings with the function name and yaml metadata for easy consumption by hugo for the website. all other docs have been moved to markdown as well this is the main reason this is a "breaking" change users will have to reinstall hilbish (task uninstall and task install) to remove the old plaintext docs
2022-12-15 04:00:54 +00:00
chore: update docs
2023-12-02 12:23:49 +00:00
Saves the current state of the terminal
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 15:30:51 +00:00
#### Parameters
This function has no parameters.
docs: turn properties list into a table also fix member functions causing a spam of separators
2023-09-02 20:01:57 +00:00
</div>
<hr><div id='setRaw'>
docs: make various style changes - add a table that lists module functions - add highlight when jumping to a function - separators
2023-09-02 18:18:40 +00:00
<h4 class='heading'>
terminal.setRaw()
<a href="#setRaw" class='heading-link'>
<i class="fas fa-paperclip"></i>
</a>
</h4>
refactor!: rework docs and doc command (#218) changes the actual file format of docs to markup since that's basically what we have been using in the first place. the docgen command has been modified to write markdown headings with the function name and yaml metadata for easy consumption by hugo for the website. all other docs have been moved to markdown as well this is the main reason this is a "breaking" change users will have to reinstall hilbish (task uninstall and task install) to remove the old plaintext docs
2022-12-15 04:00:54 +00:00
chore: update docs
2023-12-02 12:23:49 +00:00
Puts the terminal in raw mode
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 15:30:51 +00:00
#### Parameters
This function has no parameters.
docs: turn properties list into a table also fix member functions causing a spam of separators
2023-09-02 20:01:57 +00:00
</div>
<hr><div id='size'>
docs: make various style changes - add a table that lists module functions - add highlight when jumping to a function - separators
2023-09-02 18:18:40 +00:00
<h4 class='heading'>
terminal.size()
<a href="#size" class='heading-link'>
<i class="fas fa-paperclip"></i>
</a>
</h4>
refactor!: rework docs and doc command (#218) changes the actual file format of docs to markup since that's basically what we have been using in the first place. the docgen command has been modified to write markdown headings with the function name and yaml metadata for easy consumption by hugo for the website. all other docs have been moved to markdown as well this is the main reason this is a "breaking" change users will have to reinstall hilbish (task uninstall and task install) to remove the old plaintext docs
2022-12-15 04:00:54 +00:00
chore: update docs
2023-12-02 12:23:49 +00:00
Gets the dimensions of the terminal. Returns a table with `width` and `height`
Note: this is not the size in relation to the dimensions of the display
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 15:30:51 +00:00
#### Parameters
This function has no parameters.
docs: turn properties list into a table also fix member functions causing a spam of separators
2023-09-02 20:01:57 +00:00
</div>