2
2
kopie van https://github.com/Hilbis/Hilbish synced 2025-07-15 15:22:03 +00:00
Hilbish/docs/api/hilbish/hilbish.history.md
sammyette aa7e899db4
docs: make various style changes
- add a table that lists module functions
- add highlight when jumping to a function
- separators
2023-09-02 14:18:40 -04:00

2.0 KiB

title description layout menu
Module hilbish.history command history doc
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

add(cmd) Adds a command to the history.
all() -> table Retrieves all history.
clear() Deletes all commands from the history.
get(idx) Retrieves a command from the history based on the idx.
size() -> number Returns the amount of commands in the history.

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.