Class YDocument<T>`Abstract`

Generic shareable document.

Type Parameters

T extends DocumentChange

Hierarchy

YDocument
- YFile
- YNotebook

Implements

ISharedDocument

Index

Constructors

Properties

_awareness _changed _disposed _isDisposed _undoManager _ydoc _ystate version

Accessors

awareness changed disposed isDisposed source state undoManager ydoc ystate

Methods

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

Constructors

constructor

new YDocument<T>(options?: YDocument.IOptions): YDocument<T>
Type Parameters
- T extends DocumentChange
Parameters
- Optional options: YDocument.IOptions
Returns YDocument<T>
- Defined in src/ydocument.ts:18

Properties

`Private` _awareness

_awareness: Awareness

`Protected` _changed

_changed: Signal<YDocument<T>, T> = ...

`Private` _disposed

_disposed: Signal<YDocument<T>, void> = ...

`Private` _isDisposed

_isDisposed: boolean = false

`Private` _undoManager

_undoManager: UndoManager

`Private` _ydoc

_ydoc: Doc

`Private` _ystate

_ystate: YMap<any>

`Readonly` `Abstract` version

version: string

Document version

Accessors

awareness

get awareness(): Awareness
Shared awareness

Returns Awareness
Implementation of ISharedDocument.awareness
- Defined in src/ydocument.ts:62

changed

get changed(): ISignal<this, T>
The changed signal.

Returns ISignal<this, T>
Implementation of ISharedDocument.changed
- Defined in src/ydocument.ts:69

disposed

get disposed(): ISignal<this, void>
A signal emitted when the document is disposed.

Returns ISignal<this, void>
Implementation of ISharedDocument.disposed
- Defined in src/ydocument.ts:76

isDisposed

get isDisposed(): boolean
Whether the document is disposed or not.

Returns boolean
Implementation of ISharedDocument.isDisposed
- Defined in src/ydocument.ts:83

source

get source(): JSONValue
Get the document source

Returns
The source

Returns JSONValue
- Defined in src/ydocument.ts:153
set source(value: JSONValue): void
Set the document source
Parameters
- value: JSONValue
  
  The source to set
Returns void
- Defined in src/ydocument.ts:162

state

get state(): JSONObject
Document state

Returns JSONObject
Implementation of ISharedDocument.state
- Defined in src/ydocument.ts:90

undoManager

get undoManager(): UndoManager
YJS document undo manager

Returns UndoManager
- Defined in src/ydocument.ts:55

ydoc

get ydoc(): Doc
YJS document.

Returns Doc
- Defined in src/ydocument.ts:41

ystate

get ystate(): YMap<any>
Shared state

Returns YMap<any>
- Defined in src/ydocument.ts:48

Methods

canRedo

canRedo(): boolean
Whether the object can redo changes.

Returns boolean
Implementation of ISharedDocument.canRedo
- Defined in src/ydocument.ts:104

canUndo

canUndo(): boolean
Whether the object can undo changes.

Returns boolean
Implementation of ISharedDocument.canUndo
- Defined in src/ydocument.ts:97

clearUndoHistory

clearUndoHistory(): void
Clear the change stack.

Returns void
Implementation of ISharedDocument.clearUndoHistory
- Defined in src/ydocument.ts:197

dispose

dispose(): void
Dispose of the resources.

Returns void
Implementation of ISharedDocument.dispose
- Defined in src/ydocument.ts:111

`Abstract` getSource

getSource(): JSONValue
Get the document source

Returns
The source

Returns JSONValue
Implementation of ISharedDocument.getSource
- Defined in src/ydocument.ts:171

getState

getState(key: string): undefined | JSONValue
Get the value for a state attribute
Parameters
- key: string
  
  Key to get
Returns undefined | JSONValue
Implementation of ISharedDocument.getState
- Defined in src/ydocument.ts:129

`Protected` onStateChanged

onStateChanged(event: YMapEvent<any>): void
Handle a change to the ystate.
Parameters
- event: YMapEvent<any>
Returns void
- Defined in src/ydocument.ts:212

redo

redo(): boolean
Redo an operation.

Returns boolean
Implementation of ISharedDocument.redo
- Defined in src/ydocument.ts:190

`Abstract` setSource

setSource(value: JSONValue): void
Set the document source
Parameters
- value: JSONValue
  
  The source to set
Returns void
Implementation of ISharedDocument.setSource
- Defined in src/ydocument.ts:178

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
Implementation of ISharedDocument.setState
- Defined in src/ydocument.ts:142

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)
  - - (): void
    - Returns void
- undoable: boolean = true
- origin: any = null
Returns void
Implementation of ISharedDocument.transact
- Defined in src/ydocument.ts:205

undo

undo(): boolean
Undo an operation.

Returns boolean
Implementation of ISharedDocument.undo
- Defined in src/ydocument.ts:183

Generated using TypeDoc