Class FileBrowserModel

constructor

• new FileBrowserModel(options): FileBrowserModel

• Construct a new file browser model.

  Parameters

  • options: FileBrowserModel.IOptions

  Returns FileBrowserModel

Readonly manager

connectionFailure

• get connectionFailure(): ISignal<this, Error>

• A signal emitted when the file browser model loses connection.

  Returns ISignal<this, Error>

driveName

• get driveName(): string

• The drive name that gets prepended to the path.

  Returns string

fileChanged

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

• Get the file path changed signal.

  Returns ISignal<this, Contents.IChangedArgs>

isDisposed

• get isDisposed(): boolean

• Get whether the model is disposed.

  Returns boolean

path

• get path(): string

• Get the current path.

  Returns string

pathChanged

• get pathChanged(): ISignal<this, IChangedArgs<string, string, string>>

• A signal emitted when the path changes.

  Returns ISignal<this, IChangedArgs<string, string, string>>

refreshed

• get refreshed(): ISignal<this, void>

• A signal emitted when the directory listing is refreshed.

  Returns ISignal<this, void>

restored

• get restored(): Promise<void>

• A promise that resolves when the model is first restored.

  Returns Promise<void>

rootPath

• get rootPath(): string

• Get the root path

  Returns string

specs

• get specs(): null | ISpecModels

• Get the kernel spec models.

  Returns null | ISpecModels

uploadChanged

• get uploadChanged(): ISignal<this, IChangedArgs<null | IUploadModel, null | IUploadModel, string>>

• A signal emitted when an upload progresses.

  Returns ISignal<this, IChangedArgs<null | IUploadModel, null | IUploadModel, string>>

cd

• cd(path?): Promise<void>

• Change directory.

  Parameters

  • path: string = '.'

    The path to the file or directory.

  Returns Promise<void>

  A promise with the contents of the directory.

dispose

• dispose(): void

• Dispose of the resources held by the model.

  Returns void

download

• download(path): Promise<void>

• Download a file.

  Parameters

  • path: string

    The path of the file to be downloaded.

  Returns Promise<void>

  A promise which resolves when the file has begun downloading.

items

• items(): IterableIterator<Contents.IModel>

• Create an iterator over the model's items.

  Returns IterableIterator<Contents.IModel>

  A new iterator over the model's items.

refresh

• refresh(): Promise<void>

• Force a refresh of the directory contents.

  Returns Promise<void>

restore

• restore(id, populate?): Promise<void>

• Restore the state of the file browser.

  Parameters

  • id: string

    The unique ID that is used to construct a state database key.
  • populate: boolean = true

    If false, the restoration ID will be set but the file browser state will not be fetched from the state database.

  Returns Promise<void>

  A promise when restoration is complete.

  Notes

  This function will only restore the model once. If it is called multiple times, all subsequent invocations are no-ops.

sessions

• sessions(): IterableIterator<Session.IModel>

• Create an iterator over the active sessions in the directory.

  Returns IterableIterator<Session.IModel>

  A new iterator over the model's active sessions.

upload

• upload(file): Promise<Contents.IModel>

• Upload a File object.

  Parameters

  • file: File

    The File object to upload.

  Returns Promise<Contents.IModel>

  A promise containing the new file contents model.

  Notes

  On Notebook version < 5.1.0, this will fail to upload files that are too big to be sent in one request to the server. On newer versions, or on Jupyter Server, it will ask for confirmation then upload the file in 1 MB chunks.

uploads

• uploads(): IterableIterator<IUploadModel>

• Create an iterator over the status of all in progress uploads.

  Returns IterableIterator<IUploadModel>