@jupyterlite

***`

@jupyterlite / @jupyterlite/contents / BrowserStorageDrive

类:BrowserStorageDrive#

定义于:packages/contents/src/drive.ts:40

用于在浏览器存储中存储文件的自定义驱动器。

实现#

  • IDrive

构造函数#

构造函数#

**new BrowserStorageDrive**(options):BrowserStorageDrive

定义于:packages/contents/src/drive.ts:44

构造一个新的由 localForage 驱动的内容提供程序

参数#

选项#

IOptions

返回#

BrowserStorageDrive

访问器#

checkpoints#

获取签名#

**get** protected **checkpoints**():Promise<LocalForage>

定义于:packages/contents/src/drive.ts:171

对底层检查点的延迟引用。

返回#

Promise<LocalForage>

`***

counters#

获取签名#

get protected counters():Promise<LocalForage>

定义于:packages/contents/src/drive.ts:164

对底层计数器的延迟引用。

返回#

Promise<LocalForage>

***`

defaultStorageOptions#

获取签名#

**get** protected **defaultStorageOptions**():LocalForageOptions

定义于:packages/contents/src/drive.ts:178

获取 localForage 实例的默认选项

返回#

LocalForageOptions

`***

fileChanged#

获取签名#

get fileChanged():ISignal<IDrive, IChangedArgs>

定义于:packages/contents/src/drive.ts:88

发生文件操作时发出的信号。

返回#

ISignal<IDrive, IChangedArgs>

实现#

Contents.IDrive.fileChanged

***`

isDisposed#

获取签名#

**get** **isDisposed**():boolean

定义于:packages/contents/src/drive.ts:67

驱动器是否已释放。

返回#

boolean

实现于#

Contents.IDrive.isDisposed

`***

name#

获取签名#

get name():string

定义于:packages/contents/src/drive.ts:74

驱动器的名称。

返回#

string

实现于#

Contents.IDrive.name

***`

ready#

获取签名#

**get** **ready**(): Promise<void>

定义于:packages/contents/src/drive.ts:150

一个承诺,在所有存储完全初始化后解决。

返回#

Promise<void>

`***

serverSettings#

获取签名#

get serverSettings():ISettings

定义于:packages/contents/src/drive.ts:81

驱动器的服务器设置。

返回#

ISettings

实现自#

Contents.IDrive.serverSettings

***`

storage#

获取签名#

**get** protected **storage**():Promise<LocalForage>

定义于:packages/contents/src/drive.ts:157

对底层存储的延迟引用。

返回#

Promise<LocalForage>

方法#

clearStorage()#

**clearStorage**():Promise<void>

定义于:packages/contents/src/drive.ts:226

清除所有存储(文件、计数器和检查点)。

返回#

Promise<void>

一个承诺,在所有存储清除后解决。

`***

copy()#

copy(path, toDir):Promise<IModel>

定义于:packages/contents/src/drive.ts:360

将文件复制到给定目录中。

参数#

path#

string

原始文件路径。

toDir#

string

目标目录路径。

返回#

Promise<IModel>

一个承诺,在文件复制后,用新的内容模型解决。

备注#

服务器将选择复制文件的名称。

实现自#

Contents.IDrive.copy

***`

createCheckpoint()#

**createCheckpoint**(path):Promise<ICheckpointModel>

定义于:packages/contents/src/drive.ts:689

为文件创建检查点。

参数#

path#

string

文件的路径。

返回#

Promise<ICheckpointModel>

一个承诺,在创建检查点后,用新的检查点模型解决。

实现自#

Contents.IDrive.createCheckpoint

`***

createDefaultCheckpoints()#

protected createDefaultCheckpoints():LocalForage

定义于:packages/contents/src/drive.ts:213

创建默认检查点存储。

返回#

LocalForage

***`

createDefaultCounters()#

protected **createDefaultCounters**():LocalForage

定义于:packages/contents/src/drive.ts:202

初始化用于计算文件后缀的默认存储。

返回#

LocalForage

`***

createDefaultStorage()#

protected createDefaultStorage():LocalForage

定义于:packages/contents/src/drive.ts:191

初始化内容文件的默认存储。

返回#

LocalForage

***`

delete()#

**delete**(path):Promise<void>

定义于:packages/contents/src/drive.ts:655

从浏览器存储中删除文件。

对服务器备份的文件没有影响,它们将以原始时间戳重新出现。

参数#

path#

string

文件的路径。

返回#

Promise<void>

实现自#

Contents.IDrive.delete

`***

deleteCheckpoint()#

deleteCheckpoint(path, checkpointID):Promise<void>

定义于:packages/contents/src/drive.ts:750

删除文件的检查点。

参数#

path#

string

文件的路径。

checkpointID#

string

要删除的检查点的 ID。

返回#

Promise<void>

一个承诺,在删除检查点后解决。

实现自#

Contents.IDrive.deleteCheckpoint

***`

dispose()#

**dispose**(): void

定义于:packages/contents/src/drive.ts:56

释放驱动器。

返回#

void

实现自#

Contents.IDrive.dispose

`***

forgetPath()#

protected forgetPath(path):Promise<void>

定义于:packages/contents/src/drive.ts:674

删除路径的 localForage 和检查点。

参数#

path#

string

文件的路径

返回#

Promise<void>

***`

get()#

**get**(path, options?):Promise<IModel>

定义于:packages/contents/src/drive.ts:402

获取文件或目录。

参数#

path#

string

options?#

IFetchOptions

返回#

Promise<IModel>

一个承诺,用文件内容解决。

实现自#

Contents.IDrive.get

`***

getDownloadUrl()#

getDownloadUrl(path):Promise<string>

定义于:packages/contents/src/drive.ts:95

获取下载 URL

参数#

path#

string

返回#

Promise<string>

实现自#

Contents.IDrive.getDownloadUrl

***`

initialize()#

**initialize**():Promise<void>

定义于:packages/contents/src/drive.ts:133

在服务器启动和所有扩展应用后完成任何初始化。

TODO:保持私有?

返回#

Promise<void>

`***

initStorage()#

protected initStorage():Promise<void>

定义于:packages/contents/src/drive.ts:141

初始化所有存储实例

返回#

Promise<void>

***`

listCheckpoints()#

**listCheckpoints**(path):Promise<ICheckpointModel[]>

定义于:packages/contents/src/drive.ts:717

列出文件的可用检查点。

参数#

path#

string

文件的路径。

返回#

Promise<ICheckpointModel[]>

一个承诺,用文件的检查点模型列表解决。

实现#

Contents.IDrive.listCheckpoints

`***

newUntitled()#

newUntitled(options?):Promise<IModel>

定义于:packages/contents/src/drive.ts:241

在指定目录路径中创建新的无标题文件或目录。

参数#

options?#

ICreateOptions

返回#

Promise<IModel>

一个承诺,在创建文件后,用创建的文件内容解决。

实现自#

Contents.IDrive.newUntitled

***`

normalizeCheckpoint()#

protected **normalizeCheckpoint**(model, id):ICheckpointModel

定义于:packages/contents/src/drive.ts:722

参数#

model#

IModel

id#

number

返回#

ICheckpointModel

`***

reduceBytesToString()#

protected reduceBytesToString(data, byte):string

定义于:packages/contents/src/drive.ts:922

将任意二进制数据转换为字符串的 reducer

参数#

data#

string

byte#

number

返回#

string

***`

rename()#

**rename**(oldLocalPath, newLocalPath):Promise<IModel>

定义于:packages/contents/src/drive.ts:477

重命名文件或目录。

参数#

oldLocalPath#

string

原始文件路径。

newLocalPath#

string

新的文件路径。

返回#

Promise<IModel>

一个承诺,在文件重命名后,用新的文件内容模型解决。

实现自#

Contents.IDrive.rename

`***

restoreCheckpoint()#

restoreCheckpoint(path, checkpointID):Promise<void>

定义于:packages/contents/src/drive.ts:734

将文件恢复到已知检查点状态。

参数#

path#

string

文件的路径。

checkpointID#

string

要恢复的检查点的 ID。

返回#

Promise<void>

一个承诺,在检查点恢复后解决。

实现自#

Contents.IDrive.restoreCheckpoint

***`

save()#

**save**(path, options): Promise\<IModel`>

定义于:packages/contents/src/drive.ts:525

保存文件。

参数#

path#

string

所需的文件路径。

options#

Partial<IModel> = {}

模型的可选覆盖。

返回#

Promise<IModel>

一个承诺,在文件保存后,用文件内容模型解决。

实现自#

Contents.IDrive.save