Hilbish/docs/api/terminal.md

35 lines
808 B
Markdown

---
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
### terminal.restoreState()
Restores the last saved state of the terminal
#### Parameters
This function has no parameters.
### terminal.saveState()
Saves the current state of the terminal
#### Parameters
This function has no parameters.
### terminal.setRaw()
Puts the terminal in raw mode
#### Parameters
This function has no parameters.
### terminal.size()
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
#### Parameters
This function has no parameters.