Class ConsoleHistory

A console history manager object.

Implements

IConsoleHistory

Index

Constructors

Properties

_cursor _editor _filtered _hasSession _history _isDisposed _placeholder _setByHistory sessionContext

Accessors

editor isDisposed placeholder

Methods

_handleKernel back dispose forward onEdgeRequest onHistory onTextChange push reset setFilter

Constructors

constructor

new ConsoleHistory(options): ConsoleHistory
Construct a new console history object.
Parameters
- options: ConsoleHistory.IOptions
Returns ConsoleHistory
- Defined in packages/console/src/history.ts:76

Properties

`Private` _cursor

_cursor: number = 0

`Private` _editor

_editor: null | CodeEditor.IEditor = null

`Private` _filtered

_filtered: string[] = []

`Private` _hasSession

_hasSession: boolean = false

`Private` _history

_history: string[] = []

`Private` _isDisposed

_isDisposed: boolean = false

`Private` _placeholder

_placeholder: string = ''

`Private` _setByHistory

_setByHistory: boolean = false

`Readonly` sessionContext

sessionContext: null | ISessionContext

The client session used by the foreign handler.

Accessors

editor

get editor(): null | CodeEditor.IEditor
The current editor used by the history manager.

Returns null | CodeEditor.IEditor
Implementation of IConsoleHistory.editor
- Defined in packages/console/src/history.ts:93
set editor(value): void
The current editor used by the history widget.
Parameters
- value: null | CodeEditor.IEditor
Returns void
Implementation of IConsoleHistory.editor
- Defined in packages/console/src/history.ts:96

isDisposed

get isDisposed(): boolean
Get whether the console history manager is disposed.

Returns boolean
Implementation of IConsoleHistory.isDisposed
- Defined in packages/console/src/history.ts:125

placeholder

get placeholder(): string
The placeholder text that a history session began with.

Returns string
Implementation of IConsoleHistory.placeholder
- Defined in packages/console/src/history.ts:118

Methods

`Private` _handleKernel

_handleKernel(): Promise<void>
Handle the current kernel changing.

Returns Promise<void>
- Defined in packages/console/src/history.ts:298

back

back(placeholder): Promise<string>
Get the previous item in the console history.
Parameters
- placeholder: string
  The placeholder string that gets temporarily added to the history only for the duration of one history session. If multiple placeholders are sent within a session, only the first one is accepted.
Returns Promise<string>
A Promise for console command text or undefined if unavailable.
Implementation of IConsoleHistory.back
- Defined in packages/console/src/history.ts:147

dispose

dispose(): void
Dispose of the resources held by the console history manager.

Returns void
Implementation of IConsoleHistory.dispose
- Defined in packages/console/src/history.ts:132

forward

forward(placeholder): Promise<string>
Get the next item in the console history.
Parameters
- placeholder: string
  The placeholder string that gets temporarily added to the history only for the duration of one history session. If multiple placeholders are sent within a session, only the first one is accepted.
Returns Promise<string>
A Promise for console command text or undefined if unavailable.
Implementation of IConsoleHistory.forward
- Defined in packages/console/src/history.ts:171

`Protected` onEdgeRequest

onEdgeRequest(editor, location): void
Handle an edge requested signal.
Parameters
- editor: CodeEditor.IEditor
- location: EdgeLocation
Returns void
- Defined in packages/console/src/history.ts:252

`Protected` onHistory

onHistory(value): void
Populate the history collection on history reply from a kernel.
Parameters
- value: IHistoryReplyMsg
  The kernel message history reply.
  
  Notes
  History entries have the shape: [session: number, line: number, input: string] Contiguous duplicates are stripped out of the API response.
Returns void
- Defined in packages/console/src/history.ts:222

`Protected` onTextChange

onTextChange(): void
Handle a text change signal from the editor.

Returns void
- Defined in packages/console/src/history.ts:241

push

push(item): void
Add a new item to the bottom of history.
Parameters
- item: string
  The item being added to the bottom of history.
  
  Notes
  If the item being added is undefined or empty, it is ignored. If the item being added is the same as the last item in history, it is ignored as well so that the console's history will consist of no contiguous repetitions.
Returns void
Implementation of IConsoleHistory.push
- Defined in packages/console/src/history.ts:196

reset

reset(): void
Reset the history navigation state, i.e., start a new history session.

Returns void
Implementation of IConsoleHistory.reset
- Defined in packages/console/src/history.ts:206

`Protected` setFilter

setFilter(filterStr?): void
Set the filter data.
Parameters
- filterStr: string = ''
  The string to use when filtering the data.
Returns void
- Defined in packages/console/src/history.ts:315