Readonly activateA signal emitted when one of the documents is activated.
Whether to autosave documents.
Determines the time interval for autosave in seconds.
Whether to ask confirmation to close a tab or not.
Readonly isDefines max acceptable difference, in milliseconds, between last modified timestamps on disk and client.
Readonly registryThe registry used by the manager.
Whether to ask the user to rename untitled file on first manual save.
Readonly servicesThe service manager used by the manager.
Readonly stateSignal triggered when an attribute changes.
Clone a widget.
The source widget.
A new widget or undefined.
Uses the same widget factory and context as the source, or returns
undefined if the source widget is not managed by this manager.
Get the document context for a widget.
The widget of interest.
The context associated with the widget, or undefined if no such
context exists.
Delete a file.
The full path to the file to be deleted.
A promise which resolves when the file is deleted.
If there is a running session associated with the file and no other sessions are using the kernel, the session will be shut down.
Dispose of the resources held by the object.
If the object's dispose method is called more than once, all
calls made after the first will be a no-op.
It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.
See if a widget already exists for the given path and widget name.
The file path to use.
Optional widgetName: stringThe name of the widget factory to use. 'default' will use the default widget.
The found widget, or undefined.
This can be used to find an existing widget instead of opening a new widget.
Open a file and return the widget used to view it.
The file path to open.
Optional widgetName: stringThe name of the widget factory to use. 'default' will use the default widget.
Optional kernel: Partial<Kernel.IModel>An optional kernel name/id to override the default.
Optional options: IOpenOptionsThe created widget, or undefined.
This function will return undefined if a valid widget factory
cannot be found.
Open a file and return the widget used to view it. Reveals an already existing editor.
The file path to open.
Optional widgetName: stringThe name of the widget factory to use. 'default' will use the default widget.
Optional kernel: Partial<Kernel.IModel>An optional kernel name/id to override the default.
Optional options: IOpenOptionsThe created widget, or undefined.
This function will return undefined if a valid widget factory
cannot be found.
Rename a file or directory.
The full path to the original file.
The full path to the new file.
A promise containing the new file contents model. The promise will reject if the newPath already exists. Use [[overwrite]] to overwrite a file.
Generated using TypeDoc
The interface for a document manager.