Class CompletionConnector

A context+kernel connector for completion handlers. A namespace for completion connector statics.

Hierarchy

DataConnector<IReply, void, IRequest>
- CompletionConnector

Implements

IDataConnector<IReply, void, IRequest>

Index

Type aliases

IOptions

Constructors

constructor

Properties

Methods

Type aliases

Static IOptions

IOptions: IOptions & IOptions

The instantiation options for cell completion handlers.

Constructors

constructor

new CompletionConnector(options: IOptions): CompletionConnector

- Defined in connector.ts:19
Create a new connector for completion requests.

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

Properties

Private _context

_context: ContextConnector

Private _kernel

_kernel: KernelConnector

Methods

fetch

fetch(request: IRequest): Promise<IReply>

Overrides DataConnector.fetch
- Defined in connector.ts:36
Fetch completion requests.

Parameters
- request: IRequest
  
  The completion 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