cp.console.history.md

docs » cp.console.history

---

Console History Manager.

Based on code by @asmagill https://github.com/asmagill/hammerspoon-config-take2/blob/master/utils/_actions/consoleHistory.lua

API Overview

• Functions - API calls offered directly by the extension
• clearHistory
• history
• init
• pruneHistory
• retrieveHistory
• saveHistory
• Fields - Variables which can only be accessed from an object returned by a constructor
• cache

API Documentation

Functions

clearHistory

Signature	cp.console.history.clearHistory() -> none
Type	Function
Description	Clears the Console History.
Parameters	None
Returns	None

history

Signature	cp.console.history.history(toFind) -> none
Type	Function
Description	Gets a history item.
Parameters	toFind - Number of the item to find.
Returns	None

init

Signature	cp.console.history.init() -> self
Type	Function
Description	Initialise the module.
Parameters	None
Returns	Self

pruneHistory

Signature	cp.console.history.pruneHistory() -> number
Type	Function
Description	Prune History
Parameters	None
Returns	Current History Count

retrieveHistory

Signature	cp.console.history.retrieveHistory() -> none
Type	Function
Description	Retrieve's the Console History.
Parameters	None
Returns	None

saveHistory

Signature	cp.console.history.saveHistory() -> none
Type	Function
Description	Saves the Console History.
Parameters	None
Returns	None

Fields

cache

Signature	cp.console.history.cache <cp.prop: table>
Type	Field
Description	Console History Cache