Module hilbish.history

Sidebar

  • Vim Mode
  • Completions
  • Lunacolors
  • Frequently Asked Questions
  • Getting Started
  • Introduction
  • Module hilbish
  • Module fs
  • Module snail
  • Module terminal
  • Module commander
  • API
  • Module bait
  • Module hilbish.module
  • Module hilbish.abbr
  • Module hilbish.userDir
  • Module hilbish.os
  • Module hilbish.history
  • Module hilbish.completion
  • Module hilbish.messages
  • Module hilbish.aliases
  • Module hilbish.runner
  • Module hilbish.timers
  • Module hilbish
  • Module hilbish.jobs
  • Module hilbish.editor
  • Actions
  • Module doc
  • Nature
  • Module dirs
  • Hilbish
  • Command
  • Signals
  • Signal
  • Notification
  • Runner Mode
  • Options
  • Features

Module hilbish.history

Introduction The history interface deals with command history. This includes the ability to override functions to change the main method of saving history.

Functions ||| |----|----| |<a href="#history.add">add(cmd)</a>|Adds a command to the history.| |<a href="#history.all">all() -> table</a>|Retrieves all history as a table.| |<a href="#history.clear">clear()</a>|Deletes all commands from the history.| |<a href="#history.get">get(index)</a>|Retrieves a command from the history based on the index.| |<a href="#history.size">size() -> number</a>|Returns the amount of commands in the history.|

<hr> <div id='history.add'> <h4 class='heading'> hilbish.history.add(cmd) <a href="#history.add" class='heading-link'> <i class="fas fa-paperclip"></i> </a> </h4>

Adds a command to the history.

Parameters string **cmd**

</div>

<hr> <div id='history.all'> <h4 class='heading'> hilbish.history.all() -> table <a href="#history.all" class='heading-link'> <i class="fas fa-paperclip"></i> </a> </h4>

Retrieves all history as a table.

Parameters This function has no parameters. </div>

<hr> <div id='history.clear'> <h4 class='heading'> hilbish.history.clear() <a href="#history.clear" class='heading-link'> <i class="fas fa-paperclip"></i> </a> </h4>

Deletes all commands from the history.

Parameters This function has no parameters. </div>

<hr> <div id='history.get'> <h4 class='heading'> hilbish.history.get(index) <a href="#history.get" class='heading-link'> <i class="fas fa-paperclip"></i> </a> </h4>

Retrieves a command from the history based on the index.

Parameters number **index**

</div>

<hr> <div id='history.size'> <h4 class='heading'> hilbish.history.size() -> number <a href="#history.size" class='heading-link'> <i class="fas fa-paperclip"></i> </a> </h4>

Returns the amount of commands in the history.

Parameters This function has no parameters. </div>