feat: add an ability to initialize with custom history

mkrl · Jul 20, 2023 · fccfb4c · fccfb4c
1 parent 51ade4e
commit fccfb4c
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -109,6 +109,7 @@ An object that's being passed to every command function & returned by `initTermi
 | `enableHelp`: boolean | Toggle default `help` command that lists all the available commands and their descriptions. | true |
 | `prompt`: string | Terminal prompt | '$: ' |
 | `historyLength`: number | A maximum amount of commands that can be stored in the terminal history | 50 |
+| `history`: string[] | A default value for terminal history (can be used to preserve history across sessions) | [] |
 | `commands`: object | `commands` object |  |
 
 ### commands object

diff --git a/src/api/init.ts b/src/api/init.ts
@@ -15,6 +15,7 @@ const initTerminal = ({
   welcomeMessage,
   prompt = '$: ',
   historyLength = 50,
+  history = [],
   enableHelp = true,
   commands
 }: TerminalSettings) => {
@@ -30,7 +31,7 @@ const initTerminal = ({
   const { commandContainer, input, inputContainer } = buildTree(host, prompt)
 
   const terminal: TerminalInstance = {
-    history: [],
+    history,
     lastHistoryIndex: 0,
     isProcessRunning: false,
     settings,

diff --git a/src/types/terminalSettings.ts b/src/types/terminalSettings.ts
@@ -6,5 +6,6 @@ export type TerminalSettings = {
   welcomeMessage?: string,
   prompt?: string
   historyLength?: number
+  history?: string[],
   enableHelp?: boolean
 }