***`
@jupyterlite / @jupyterlite/session / LiteSessionClient
类:LiteSessionClient#
定义于:client.ts:20
一个处理对 /api/sessions 请求的类
实现#
ISessionAPIClient
构造函数#
构造函数#
**new LiteSessionClient**(options):LiteSessionClient
定义于:client.ts:26
构造一个新的 LiteSessionClient。
参数#
选项#
LiteSessionClient 的实例化选项。
返回#
LiteSessionClient
访问器#
serverSettings#
获取签名#
**get****serverSettings**():ISettings
定义于:client.ts:69
会话客户端的服务器设置。
返回#
ISettings
实现#
ISessionAPIClient.serverSettings
方法#
getModel()#
**getModel**(id):Promise<IModel>
定义于:client.ts:78
通过 ID 获取会话。
参数#
id#
string
会话的 ID。
返回#
Promise<IModel>
实现于#
ISessionAPIClient.getModel
`***
listRunning()#
listRunning():Promise<IModel[]>
定义于:client.ts:89
列出正在运行的会话
返回#
Promise<IModel[]>
实现#
ISessionAPIClient.listRunning
***`
shutdown()#
**shutdown**(id):Promise<void>
定义于:client.ts:195
关闭会话。
参数#
id#
string
要关闭的会话的 ID。
返回#
Promise<void>
实现于#
ISessionAPIClient.shutdown
`***
shutdownAll()#
shutdownAll():Promise<void>
定义于:client.ts:210
关闭所有会话。
返回#
Promise<void>
***`
startNew()#
**startNew**(options):Promise<IModel>
定义于:client.ts:153
启动新会话 TODO: 读取路径和名称
参数#
options#
ISessionOptions
启动新会话的选项。
返回#
Promise<IModel>
实现#
ISessionAPIClient.startNew
`***
update()#
update(options):Promise<IModel>
定义于:client.ts:102
修补现有会话。这可用于重命名会话。
路径更新会话以跟踪重命名后的路径
kernel.name 启动具有给定内核规范的新内核
参数#
options#
DeepPartial<IModel>
用于修补会话的选项。
返回#
Promise<IModel>
实现#
ISessionAPIClient.update