Class KernelConnector

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

Hierarchy (view full)

DataConnector<IReply, void, InspectionHandler.IRequest>
- KernelConnector

Index

Constructors

Properties

_sessionContext

Methods

fetch list remove save

Constructors

constructor

new KernelConnector(options): KernelConnector
Create a new kernel connector for inspection requests.
Parameters
- options: KernelConnector.IOptions
  The instantiation options for the kernel connector.
Returns KernelConnector
Overrides DataConnector.constructor
- Defined in packages/inspector/src/kernelconnector.ts:22

Properties

`Private` _sessionContext

_sessionContext: ISessionContext

Methods

fetch

fetch(request): Promise<IReply>
Fetch inspection requests.
Parameters
- request: InspectionHandler.IRequest
  The inspection request text and details.
Returns Promise<IReply>
Overrides DataConnector.fetch
- Defined in packages/inspector/src/kernelconnector.ts:32

list

list(query?): Promise<{
ids: InspectionHandler.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: InspectionHandler.IRequest[];
values: IReply[];
}>
A promise that always rejects with an error.

Notes
Subclasses should reimplement if they support a back-end that can list.
Inherited from DataConnector.list
- Defined in packages/statedb/lib/dataconnector.d.ts:47

remove

remove(id): Promise<any>
Remove a value using the data connector.
Parameters
- id: InspectionHandler.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.
Inherited from DataConnector.remove
- Defined in packages/statedb/lib/dataconnector.d.ts:61

save

save(id, value): Promise<any>
Save a value using the data connector.
Parameters
- id: InspectionHandler.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.
Inherited from DataConnector.save
- Defined in packages/statedb/lib/dataconnector.d.ts:74