Class YDocument<T>Abstract

constructor

• new YDocument<T extends DocumentChange>(
      options?: YDocument.IOptions,
  ): YDocument<T>

  Type Parameters

  • T extends DocumentChange

  Parameters

  • Optionaloptions: YDocument.IOptions

  Returns YDocument<T>

Abstract Readonlyversion

awareness

• get awareness(): Awareness

  Shared awareness

  Returns Awareness

changed

• get changed(): ISignal<this, T>

  The changed signal.

  Returns ISignal<this, T>

dirty

• get dirty(): boolean

  Document dirty state

  Returns boolean

• set dirty(value: boolean): void

  Set the document dirty state

  Parameters

  • value: boolean

    The dirty state to set

  Returns void

disposed

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

  A signal emitted when the document is disposed.

  Returns ISignal<this, void>

isDisposed

• get isDisposed(): boolean

  Whether the document is disposed or not.

  Returns boolean

source

• get source(): JSONValue

  Get the document source

  Returns JSONValue

  The source

• set source(value: JSONValue): void

  Set the document source

  Parameters

  • value: JSONValue

    The source to set

  Returns void

state

• get state(): JSONObject

  Document state

  Returns JSONObject

undoManager

• get undoManager(): UndoManager

  YJS document undo manager

  Returns UndoManager

ydoc

• get ydoc(): Doc

  YJS document.

  Returns Doc

ystate

• get ystate(): YMap<any>

  Shared state

  Returns YMap<any>

canRedo

• canRedo(): boolean

  Whether the object can redo changes.

  Returns boolean

canUndo

• canUndo(): boolean

  Whether the object can undo changes.

  Returns boolean

clearUndoHistory

• clearUndoHistory(): void

  Clear the change stack.

  Returns void

dispose

• dispose(): void

  Dispose of the resources.

  Returns void

AbstractgetSource

• getSource(): JSONValue

  Get the document source

  Returns JSONValue

  The source

getState

• getState(key: string): JSONValue | undefined

  Get the value for a state attribute

  Parameters

  • key: string

    Key to get

  Returns JSONValue | undefined

redo

• redo(): boolean

  Redo an operation.

  Returns boolean

AbstractsetSource

• setSource(value: JSONValue): void

  Set the document source

  Parameters

  • value: JSONValue

    The source to set

  Returns void

setState

• setState(key: string, value: JSONValue): void

  Set the value of a state attribute

  Parameters

  • key: string

    Key to set

  • value: JSONValue

    New attribute value

  Returns void

transact

• transact(f: () => void, undoable?: boolean, origin?: any): void

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

  Parameters

  • f: () => void
  • undoable: boolean = true
  • origin: any = null

  Returns void

undo

• undo(): boolean

  Undo an operation.

  Returns boolean