@jupyterlite / @jupyterlite/services / SiteDrive
Class: SiteDrive#
Defined in: packages/services/src/contents/sitedrive.ts:35
A read-only drive exposing generated JupyterLite configuration files.
Implements#
IDrive
Constructors#
Constructor#
new SiteDrive(
options):SiteDrive
Defined in: packages/services/src/contents/sitedrive.ts:39
Construct a new site drive.
Parameters#
options#
Returns#
SiteDrive
Properties#
ready#
readonlyready:Promise<void>
Defined in: packages/services/src/contents/sitedrive.ts:47
A promise that resolves when the configuration files are ready.
Accessors#
fileChanged#
Get Signature#
get fileChanged():
ISignal<IDrive,IChangedArgs>
Defined in: packages/services/src/contents/sitedrive.ts:84
A signal emitted when a file operation takes place.
Returns#
ISignal<IDrive, IChangedArgs>
Implementation of#
Contents.IDrive.fileChanged
isDisposed#
Get Signature#
get isDisposed():
boolean
Defined in: packages/services/src/contents/sitedrive.ts:63
Whether the drive is disposed.
Returns#
boolean
Implementation of#
Contents.IDrive.isDisposed
name#
Get Signature#
get name():
string
Defined in: packages/services/src/contents/sitedrive.ts:70
The name of the drive.
Returns#
string
Implementation of#
Contents.IDrive.name
serverSettings#
Get Signature#
get serverSettings():
ISettings
Defined in: packages/services/src/contents/sitedrive.ts:77
The server settings of the drive.
Returns#
ISettings
Implementation of#
Contents.IDrive.serverSettings
Methods#
copy()#
copy(
path,toDir):Promise<IModel>
Defined in: packages/services/src/contents/sitedrive.ts:165
Copy a file - not supported by the read-only drive.
Parameters#
path#
string
toDir#
string
Returns#
Promise<IModel>
Implementation of#
Contents.IDrive.copy
createCheckpoint()#
createCheckpoint(
path):Promise<ICheckpointModel>
Defined in: packages/services/src/contents/sitedrive.ts:196
Create a checkpoint - not supported by the read-only drive.
Parameters#
path#
string
Returns#
Promise<ICheckpointModel>
Implementation of#
Contents.IDrive.createCheckpoint
delete()#
delete(
path):Promise<void>
Defined in: packages/services/src/contents/sitedrive.ts:189
Delete a file - not supported by the read-only drive.
Parameters#
path#
string
Returns#
Promise<void>
Implementation of#
Contents.IDrive.delete
deleteCheckpoint()#
deleteCheckpoint(
path,checkpointID):Promise<void>
Defined in: packages/services/src/contents/sitedrive.ts:217
Delete a checkpoint - not supported by the read-only drive.
Parameters#
path#
string
checkpointID#
string
Returns#
Promise<void>
Implementation of#
Contents.IDrive.deleteCheckpoint
dispose()#
dispose():
void
Defined in: packages/services/src/contents/sitedrive.ts:52
Dispose the drive.
Returns#
void
Implementation of#
Contents.IDrive.dispose
get()#
get(
path,options?):Promise<IModel>
Defined in: packages/services/src/contents/sitedrive.ts:91
Get a file or directory as a read-only model.
Parameters#
path#
string
options?#
IFetchOptions
Returns#
Promise<IModel>
Implementation of#
Contents.IDrive.get
getDownloadUrl()#
getDownloadUrl(
path):Promise<string>
Defined in: packages/services/src/contents/sitedrive.ts:144
Get a download URL for a file.
Parameters#
path#
string
Returns#
Promise<string>
Implementation of#
Contents.IDrive.getDownloadUrl
listCheckpoints()#
listCheckpoints(
path):Promise<ICheckpointModel[]>
Defined in: packages/services/src/contents/sitedrive.ts:203
List the checkpoints for a file - always empty for the read-only drive.
Parameters#
path#
string
Returns#
Promise<ICheckpointModel[]>
Implementation of#
Contents.IDrive.listCheckpoints
newUntitled()#
newUntitled(
options?):Promise<IModel>
Defined in: packages/services/src/contents/sitedrive.ts:158
Create a new untitled file - not supported by the read-only drive.
Parameters#
options?#
ICreateOptions
Returns#
Promise<IModel>
Implementation of#
Contents.IDrive.newUntitled
rename()#
rename(
oldLocalPath,newLocalPath):Promise<IModel>
Defined in: packages/services/src/contents/sitedrive.ts:172
Rename a file - not supported by the read-only drive.
Parameters#
oldLocalPath#
string
newLocalPath#
string
Returns#
Promise<IModel>
Implementation of#
Contents.IDrive.rename
restoreCheckpoint()#
restoreCheckpoint(
path,checkpointID):Promise<void>
Defined in: packages/services/src/contents/sitedrive.ts:210
Restore a checkpoint - not supported by the read-only drive.
Parameters#
path#
string
checkpointID#
string
Returns#
Promise<void>
Implementation of#
Contents.IDrive.restoreCheckpoint
save()#
save(
path,options):Promise<IModel>
Defined in: packages/services/src/contents/sitedrive.ts:179
Save a file - not supported by the read-only drive.
Parameters#
path#
string
options#
Partial<IModel> & IContentProvisionOptions = {}
Returns#
Promise<IModel>
Implementation of#
Contents.IDrive.save