Interface ISharedFile

Text/Markdown/Code files are represented as ISharedFile

Hierarchy

Implemented by

Properties

changed disposed isDisposed source state version

Methods

canRedo canUndo clearUndoHistory dispose getSource getState redo setSource setState transact undo updateSource

Properties

Readonly changed

changed: ISignal<ISharedFile, FileChange>

The changed signal.

Readonly disposed

disposed: ISignal<ISharedFile, void>

A signal emitted when the object is disposed.

Readonly isDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

source

source: string

Text

Readonly state

state: JSONObject

Document state

Readonly version

version: string

Document version

Methods

canRedo

canUndo

clearUndoHistory

dispose

  • Dispose of the resources held by the object.

    Notes

    If the object's dispose method is called more than once, all calls made after the first will be a no-op.

    Undefined Behavior

    It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.

    Returns void

getSource

getState

redo

setSource

setState

transact

  • Perform a transaction. While the function f is called, all changes to the shared document are bundled into a single event.

    Parameters

    • f: (() => void)

      Transaction to execute

        • (): void

        • Returns void

    • Optional undoable: boolean

      Whether to track the change in the action history or not (default true)

    Returns void

undo

updateSource

  • Replace content from start to end with value.

    Parameters

    • start: number
    • end: number
    • Optional value: string

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc