jupyter-js-services
Advanced tools
Comparing version 0.11.0 to 0.11.1
@@ -138,3 +138,3 @@ import { IAjaxSettings } from 'jupyter-js-utils'; | ||
/** | ||
* Object which manages notebook session instances. | ||
* Object which manages session instances. | ||
*/ | ||
@@ -146,3 +146,3 @@ interface IManager { | ||
getSpecs(options?: IOptions): Promise<IKernel.ISpecModels>; | ||
listRunning(options?: IOptions): Promise<IKernel.IModel[]>; | ||
listRunning(options?: IOptions): Promise<ISession.IModel[]>; | ||
/** | ||
@@ -157,7 +157,7 @@ * Start a new session. | ||
/** | ||
* Find a session by notebook path. | ||
* Find a session by path. | ||
*/ | ||
findByPath(id: string, options?: IOptions): Promise<IModel>; | ||
/** | ||
* Connect to a running notebook session. | ||
* Connect to a running session. | ||
*/ | ||
@@ -164,0 +164,0 @@ connectTo(id: string, options?: IOptions): Promise<ISession>; |
@@ -8,3 +8,3 @@ import { IKernel } from './ikernel'; | ||
/** | ||
* Construct a new notebook session manager. | ||
* Construct a new session manager. | ||
* | ||
@@ -38,3 +38,3 @@ * @param options - The default options for each session. | ||
/** | ||
* Find a session by notebook path. | ||
* Find a session by path. | ||
*/ | ||
@@ -66,3 +66,3 @@ findByPath(path: string, options?: ISession.IOptions): Promise<ISession.IModel>; | ||
* | ||
* A notebook path must be provided. If a kernel id is given, it will | ||
* A path must be provided. If a kernel id is given, it will | ||
* connect to an existing kernel. If no kernel id or name is given, | ||
@@ -69,0 +69,0 @@ * the server will start the default kernel type. |
@@ -17,3 +17,3 @@ // Copyright (c) Jupyter Development Team. | ||
/** | ||
* Construct a new notebook session manager. | ||
* Construct a new session manager. | ||
* | ||
@@ -58,3 +58,3 @@ * @param options - The default options for each session. | ||
/** | ||
* Find a session by notebook path. | ||
* Find a session by path. | ||
*/ | ||
@@ -123,3 +123,3 @@ SessionManager.prototype.findByPath = function (path, options) { | ||
* | ||
* A notebook path must be provided. If a kernel id is given, it will | ||
* A path must be provided. If a kernel id is given, it will | ||
* connect to an existing kernel. If no kernel id or name is given, | ||
@@ -136,3 +136,3 @@ * the server will start the default kernel type. | ||
if (options.path === void 0) { | ||
return Promise.reject(new Error('Must specify a notebook path')); | ||
return Promise.reject(new Error('Must specify a path')); | ||
} | ||
@@ -363,3 +363,3 @@ return Private.startSession(options).then(function (model) { | ||
/** | ||
* Get the notebook path. | ||
* Get the session path. | ||
* | ||
@@ -492,3 +492,3 @@ * #### Notes | ||
* This shuts down the existing kernel and creates a new kernel, | ||
* keeping the existing session ID and notebook path. | ||
* keeping the existing session ID and session path. | ||
*/ | ||
@@ -577,3 +577,3 @@ Session.prototype.changeKernel = function (options) { | ||
/** | ||
* Send a PATCH to the server, updating the notebook path or the kernel. | ||
* Send a PATCH to the server, updating the session path or the kernel. | ||
*/ | ||
@@ -605,3 +605,3 @@ Session.prototype._patch = function (data) { | ||
/** | ||
* A namespace for notebook session private data. | ||
* A namespace for session private data. | ||
*/ | ||
@@ -640,3 +640,3 @@ var Private; | ||
* Create a new session, or return an existing session if a session if | ||
* the notebook path already exists | ||
* the session path already exists | ||
*/ | ||
@@ -643,0 +643,0 @@ function startSession(options) { |
{ | ||
"name": "jupyter-js-services", | ||
"version": "0.11.0", | ||
"version": "0.11.1", | ||
"description": "Client APIs for the Jupyter services REST APIs", | ||
@@ -5,0 +5,0 @@ "main": "lib/index.js", |
229006