mirror of https://github.com/Hilbis/Hilbish
41 lines
900 B
Markdown
41 lines
900 B
Markdown
---
|
|
title: Module hilbish.history
|
|
description: command history
|
|
layout: doc
|
|
menu:
|
|
docs:
|
|
parent: "API"
|
|
---
|
|
|
|
## Introduction
|
|
The history interface deals with command history.
|
|
This includes the ability to override functions to change the main
|
|
method of saving history.
|
|
|
|
## Functions
|
|
### hilbish.history.add(cmd)
|
|
Adds a command to the history.
|
|
#### Parameters
|
|
This function has no parameters.
|
|
|
|
### hilbish.history.all() -> table
|
|
Retrieves all history.
|
|
#### Parameters
|
|
This function has no parameters.
|
|
|
|
### hilbish.history.clear()
|
|
Deletes all commands from the history.
|
|
#### Parameters
|
|
This function has no parameters.
|
|
|
|
### hilbish.history.get(idx)
|
|
Retrieves a command from the history based on the `idx`.
|
|
#### Parameters
|
|
This function has no parameters.
|
|
|
|
### hilbish.history.size() -> number
|
|
Returns the amount of commands in the history.
|
|
#### Parameters
|
|
This function has no parameters.
|
|
|