Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IConsoleHistory

The definition of a console history manager object.

Hierarchy

  • IDisposable

Implemented by

Index

Properties

Methods

Properties

isDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This is a read-only property which is always safe to access.

kernel

kernel: IKernel

The current kernel supplying navigation history.

Methods

back

  • back(): Promise<string>

  • Get the previous item in the console history.

    Returns Promise<string>

    A Promise for console command text or undefined if unavailable.

dispose

  • dispose(): void

  • Dispose of the resources held by the object.

    Notes

    It is generally unsafe to use the object after it has been disposed.

    If the object's dispose method is called more than once, all calls made after the first will be a no-op.

    Returns void

forward

  • forward(): Promise<string>

  • Get the next item in the console history.

    Returns Promise<string>

    A Promise for console command text or undefined if unavailable.

push

  • push(item: string): 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. This behavior varies from some shells, but the Jupyter Qt Console is implemented this way.

    Returns void

Generated using TypeDoc