Class KernelConnector

The default connector for making inspection requests from the Jupyter API. A namespace for kernel connector statics.

Hierarchy

DataConnector<IReply, void, IRequest>
- KernelConnector

Implements

IDataConnector<IReply, void, IRequest>

Index

Interfaces

IOptions

Constructors

constructor

Properties

_session

Methods

Constructors

constructor

new KernelConnector(options: IOptions): KernelConnector

- Defined in kernelconnector.ts:19
Create a new kernel connector for inspection requests.

Parameters
- options: IOptions
  
  The instatiation options for the kernel connector.
Returns KernelConnector

Properties

Private _session

_session: IClientSession

Methods

fetch

fetch(request: IRequest): Promise<IReply>

Overrides DataConnector.fetch
- Defined in kernelconnector.ts:35
Fetch inspection requests.

Parameters
- request: IRequest
  
  The inspection request text and details.
Returns Promise<IReply>

list

list(query?: any): Promise<object>

Inherited from DataConnector.list
- Defined in /Users/jgrout6/projects/release/jupyterlab/node_modules/@jupyterlab/coreutils/lib/dataconnector.d.ts:44
Retrieve the list of items available from the data connector.

Parameters
- Optional query: any
  
  The optional query filter to apply to the connector request.
Returns Promise<object>

A promise that always rejects with an error.

Notes

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

remove

remove(id: IRequest): Promise<any>

Inherited from DataConnector.remove
- Defined in /Users/jgrout6/projects/release/jupyterlab/node_modules/@jupyterlab/coreutils/lib/dataconnector.d.ts:58
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>

Inherited from DataConnector.save
- Defined in /Users/jgrout6/projects/release/jupyterlab/node_modules/@jupyterlab/coreutils/lib/dataconnector.d.ts:71
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