Options
All
  • Public
  • Public/Protected
  • All
Menu

Class KernelConnector

The default connector for making inspection requests from the Jupyter API.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • Create a new kernel connector for inspection requests.

    Parameters

    • options: IOptions

      The instantiation options for the kernel connector.

    Returns KernelConnector

Properties

Private _sessionContext

_sessionContext: any

Methods

fetch

  • Fetch inspection requests.

    Parameters

    • request: IRequest

      The inspection request text and details.

    Returns Promise<IReply>

list

  • list(query?: string): Promise<{ ids: IRequest[]; values: IReply[] }>

  • Retrieve the list of items available from the data connector.

    Parameters

    • Optional query: string

      The optional query filter to apply to the connector request.

    Returns Promise<{ ids: IRequest[]; values: IReply[] }>

    A promise that always rejects with an error.

    Notes

    Subclasses should reimplement if they support a back-end that can list.

remove

  • Remove a value using the data connector.

    Parameters

    • id: IRequest

      The identifier for the data being removed.

    Returns Promise<any>

    A promise that always rejects with an error.

    Notes

    Subclasses should reimplement if they support a back-end that can remove.

save

  • save(id: IRequest, value: void): Promise<any>

  • Save a value using the data connector.

    Parameters

    • id: IRequest

      The identifier for the data being saved.

    • value: void

      The data being saved.

    Returns Promise<any>

    A promise that always rejects with an error.

    Notes

    Subclasses should reimplement if they support a back-end that can save.

Generated using TypeDoc