Class Drive

constructor

• new Drive(options?): Drive

• Construct a new contents manager object.

  Parameters

  • Optional options: Drive.IOptions

    The options used to initialize the object.

  Returns Drive

Readonly name

Readonly serverSettings

fileChanged

• get fileChanged(): ISignal<this, Contents.IChangedArgs>

• A signal emitted when a file operation takes place.

  Returns ISignal<this, Contents.IChangedArgs>

isDisposed

• get isDisposed(): boolean

• Test whether the manager has been disposed.

  Returns boolean

copy

• copy(fromFile, toDir): Promise<Contents.IModel>

• Copy a file into a given directory.

  Parameters

  • fromFile: string

  • toDir: string

    The destination directory path.

  Returns Promise<Contents.IModel>

  A promise which resolves with the new contents model when the file is copied.

  Notes

  The server will select the name of the copied file.

  Uses the Jupyter Server API and validates the response model.

createCheckpoint

• createCheckpoint(localPath): Promise<ICheckpointModel>

• Create a checkpoint for a file.

  Parameters

  • localPath: string

    The path of the file.

  Returns Promise<ICheckpointModel>

  A promise which resolves with the new checkpoint model when the checkpoint is created.

  Notes

  Uses the Jupyter Server API and validates the response model.

delete

• delete(localPath): Promise<void>

• Delete a file.

  Parameters

  • localPath: string

    The path to the file.

  Returns Promise<void>

  A promise which resolves when the file is deleted.

  Notes

  Uses the Jupyter Server API.

deleteCheckpoint

• deleteCheckpoint(localPath, checkpointID): Promise<void>

• Delete a checkpoint for a file.

  Parameters

  • localPath: string

    The path of the file.

  • checkpointID: string

    The id of the checkpoint to delete.

  Returns Promise<void>

  A promise which resolves when the checkpoint is deleted.

  Notes

  Uses the Jupyter Server API.

dispose

• dispose(): void

• Dispose of the resources held by the manager.

  Returns void

get

• get(localPath, options?): Promise<Contents.IModel>

• Get a file or directory.

  Parameters

  • localPath: string

  • Optional options: IFetchOptions

  Returns Promise<Contents.IModel>

  A promise which resolves with the file content.

  Uses the Jupyter Server API and validates the response model.

getDownloadUrl

• getDownloadUrl(localPath): Promise<string>

• Get an encoded download url given a file path.

  Parameters

  • localPath: string

    An absolute POSIX file path on the server.

    Notes

    It is expected that the path contains no relative paths.

    The returned URL may include a query parameter.

  Returns Promise<string>

listCheckpoints

• listCheckpoints(localPath): Promise<ICheckpointModel[]>

• List available checkpoints for a file.

  Parameters

  • localPath: string

    The path of the file.

  Returns Promise<ICheckpointModel[]>

  A promise which resolves with a list of checkpoint models for the file.

  Notes

  Uses the Jupyter Server API and validates the response model.

newUntitled

• newUntitled(options?): Promise<Contents.IModel>

• Create a new untitled file or directory in the specified directory path.

  Parameters

  • Optional options: Contents.ICreateOptions

  Returns Promise<Contents.IModel>

  A promise which resolves with the created file content when the file is created.

  Notes

  Uses the Jupyter Server API and validates the response model.

rename

• rename(oldLocalPath, newLocalPath): Promise<Contents.IModel>

• Rename a file or directory.

  Parameters

  • oldLocalPath: string

    The original file path.

  • newLocalPath: string

    The new file path.

  Returns Promise<Contents.IModel>

  A promise which resolves with the new file contents model when the file is renamed.

  Notes

  Uses the Jupyter Server API and validates the response model.

restoreCheckpoint

• restoreCheckpoint(localPath, checkpointID): Promise<void>

• Restore a file to a known checkpoint state.

  Parameters

  • localPath: string

    The path of the file.

  • checkpointID: string

    The id of the checkpoint to restore.

  Returns Promise<void>

  A promise which resolves when the checkpoint is restored.

  Notes

  Uses the Jupyter Server API.

save

• save(localPath, options?): Promise<Contents.IModel>

• Save a file.

  Parameters

  • localPath: string

    The desired file path.

  • Optional options: Partial<Contents.IModel>

    Optional overrides to the model.

  Returns Promise<Contents.IModel>

  A promise which resolves with the file content model when the file is saved.

  Notes

  Ensure that model.content is populated for the file.

  Uses the Jupyter Server API and validates the response model.