***`
@jupyterlite / @jupyterlite/settings / Settings
类:Settings#
定义于:packages/settings/src/settings.ts:26
一个在浏览器中管理设置的类。
扩展#
SettingManager
实现#
IManager
构造函数#
构造函数#
**new Settings**(options):Settings
定义于:packages/settings/src/settings.ts:30
创建一个新的设置服务。
参数#
选项#
返回#
设置
覆盖#
SettingManager.constructor
属性#
serverSettings#
readonly**serverSettings**:ISettings
定义于:node_modules/@jupyterlab/services/lib/setting/index.d.ts:15
用于发出 API 请求的服务器设置。
实现#
Setting.IManager.serverSettings
继承自#
SettingManager.serverSettings
访问器#
defaultStorageOptions#
获取签名#
**get**protected**defaultStorageOptions**():LocalForageOptions
定义于:packages/settings/src/settings.ts:74
获取 localForage 实例的默认选项
返回#
LocalForageOptions
`***
ready#
获取签名#
getready():Promise<void>
定义于:packages/settings/src/settings.ts:45
一个在设置存储完全初始化后解析的 Promise
返回#
Promise<void>
***`
storage#
获取签名#
**get**protected**storage**():Promise<LocalForage>
定义于:packages/settings/src/settings.ts:52
对已初始化存储的惰性引用
返回#
Promise<LocalForage>
方法#
clear()#
**clear**():Promise<void>
定义于:packages/settings/src/settings.ts:175
清除所有存储的设置
返回#
Promise<void>
一个在设置被清除时解析的 Promise
`***
defaultSettingsStorage()#
protecteddefaultSettingsStorage():LocalForage
定义于:packages/settings/src/settings.ts:86
创建一个设置存储。
返回#
LocalForage
***`
fetch()#
**fetch**(pluginId):Promise<IPlugin>
定义于:packages/settings/src/settings.ts:100
按插件 ID 获取设置
参数#
pluginId#
string
插件的 ID
返回#
Promise<IPlugin>
实现于#
Setting.IManager.fetch
覆盖#
SettingManager.fetch
`***
initialize()#
initialize():Promise<void>
定义于:packages/settings/src/settings.ts:59
在服务器启动且所有扩展都应用后,完成任何初始化。
返回#
Promise<void>
***`
initStorage()#
protected**initStorage**():Promise<void>
定义于:packages/settings/src/settings.ts:67
准备存储
返回#
Promise<void>
`***
list()#
list(query?):Promise<{ids:string[];values:IPlugin[]; }>
定义于:packages/settings/src/settings.ts:115
获取所有设置
参数#
query?#
"ids"
返回#
Promise<{ ids: string[]; values: IPlugin[]; }>
实现#
Setting.IManager.list
覆盖#
SettingManager.list
***`
remove()#
**remove**(id):Promise<any>
定义于:node_modules/@jupyterlab/statedb/lib/dataconnector.d.ts:61
使用数据连接器删除值。
参数#
id#
string
要删除的数据的标识符。
返回#
Promise<any>
一个总是以错误拒绝的 Promise。
备注#
如果支持可删除的后端,子类应重新实现。
实现#
Setting.IManager.remove
继承自#
SettingManager.remove
`***
save()#
save(id,raw):Promise<void>
定义于:packages/settings/src/settings.ts:166
为给定插件 ID 保存设置
参数#
id#
string
raw#
string
原始设置
返回#
Promise<void>
实现#
Setting.IManager.save
覆盖#
SettingManager.save