FileBrowserModel | @jupyterlab (original) (raw)

Hierarchy (View Summary)

• FileBrowserModel
  • TogglableHiddenFileBrowserModel

Implements

• IDisposable

Index

Constructors

constructor

• new FileBrowserModel(options: FileBrowserModel.IOptions): FileBrowserModel

• Returns FileBrowserModel

Properties

Readonlymanager

Protectedtranslator

Accessors

connectionFailure

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

• Returns ISignal<this, Error>

driveName

• get driveName(): string

• Returns string

fileChanged

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

• Returns ISignal<this, Contents.IChangedArgs>

isDisposed

• get isDisposed(): boolean

• Returns boolean

path

• get path(): string

• Returns string

pathChanged

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

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

refreshed

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

• Returns ISignal<this, void>

restored

• get restored(): Promise<void>

• Returns Promise<void>

rootPath

• get rootPath(): string

• Returns string

specs

• get specs(): null | KernelSpec.ISpecModels

• Returns null | KernelSpec.ISpecModels

uploadChanged

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

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

Methods

cd

• cd(path?: string): Promise<void>

• Parameters

  • path: string = '.'

Returns Promise<void>

A promise with the contents of the directory.

dispose

• dispose(): void

• Returns void

download

• download(path: string): Promise<void>

• Returns Promise<void>

A promise which resolves when the file has begun downloading.

ProtectedhandleContents

• handleContents(contents: Contents.IModel): void

• Returns void

items

• items(): IterableIterator<Contents.IModel>

• Returns IterableIterator<Contents.IModel>

A new iterator over the model's items.

ProtectedonFileChanged

• onFileChanged(sender: Contents.IManager, change: Contents.IChangedArgs): void

• Returns void

ProtectedonRunningChanged

• onRunningChanged(
  sender: Session.IManager,
  models: Iterable<Session.IModel>,
  ): void

• Returns void

refresh

• refresh(): Promise<void>

• Returns Promise<void>

restore

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

• Parameters

  • id: string
  • populate: boolean = true

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>

• Returns IterableIterator<Session.IModel>

A new iterator over the model's active sessions.

upload

• upload(file: File, path?: string): Promise<Contents.IModel>

• Parameters

  • file: File
  • Optionalpath: string

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>

• Returns IterableIterator<IUploadModel>