Class YFile

Shareable text file.

Hierarchy

YDocument<FileChange>
- YFile

Implements

Index

Constructors

Properties

_changed version ysource

Accessors

awareness changed dirty disposed isDisposed source state undoManager ydoc ystate

Methods

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

Constructors

constructor

new YFile(): YFile
Create a new file

Notes

The document is empty and must be populated

Returns YFile
Overrides YDocument.constructor
- Defined in src/yfile.ts:24

Properties

`Protected` _changed

_changed: Signal<YFile, FileChange> = ...

`Readonly` version

version: string = '1.0.0'

Document version

`Readonly` ysource

ysource: YText = ...

YJS file text.

Accessors

awareness

get awareness(): Awareness
Shared awareness

Returns Awareness
Implementation of IYText.awareness

Inherited from YDocument.awareness
- Defined in src/ydocument.ts:62

changed

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

Returns ISignal<this, T>
Implementation of IYText.changed

Inherited from YDocument.changed
- Defined in src/ydocument.ts:69

dirty

get dirty(): boolean
Document dirty state

Returns boolean
Implementation of ISharedFile.dirty

Inherited from YDocument.dirty
- Defined in src/ydocument.ts:97
set dirty(value: boolean): void
Set the document dirty state
Parameters
- value: boolean
  
  The dirty state to set
Returns void
Implementation of ISharedFile.dirty

Inherited from YDocument.dirty
- Defined in src/ydocument.ts:106

disposed

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

Returns ISignal<this, void>
Implementation of IYText.disposed

Inherited from YDocument.disposed
- Defined in src/ydocument.ts:76

isDisposed

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

Returns boolean
Implementation of IYText.isDisposed

Inherited from YDocument.isDisposed
- Defined in src/ydocument.ts:83

source

get source(): string
File text

Returns string
Implementation of IYText.source

Overrides YDocument.source
- Defined in src/yfile.ts:50
set source(v: string): void
Text
Parameters
- v: string
Returns void
Implementation of IYText.source

Overrides YDocument.source
- Defined in src/yfile.ts:53

state

get state(): JSONObject
Document state

Returns JSONObject
Implementation of ISharedFile.state

Inherited from YDocument.state
- Defined in src/ydocument.ts:90

undoManager

get undoManager(): UndoManager
YJS document undo manager

Returns UndoManager
Implementation of IYText.undoManager

Inherited from YDocument.undoManager
- Defined in src/ydocument.ts:55

ydoc

get ydoc(): Doc
YJS document.

Returns Doc
Inherited from YDocument.ydoc
- Defined in src/ydocument.ts:41

ystate

get ystate(): YMap<any>
Shared state

Returns YMap<any>
Inherited from YDocument.ystate
- Defined in src/ydocument.ts:48

Methods

`Private` _modelObserver

_modelObserver(event: YTextEvent): void
Handle a change to the ymodel.
Parameters
- event: YTextEvent
Returns void
- Defined in src/yfile.ts:111

canRedo

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

Returns boolean
Implementation of IYText.canRedo

Inherited from YDocument.canRedo
- Defined in src/ydocument.ts:122

canUndo

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

Returns boolean
Implementation of IYText.canUndo

Inherited from YDocument.canUndo
- Defined in src/ydocument.ts:115

clearUndoHistory

clearUndoHistory(): void
Clear the change stack.

Returns void
Implementation of IYText.clearUndoHistory

Inherited from YDocument.clearUndoHistory
- Defined in src/ydocument.ts:223

dispose

dispose(): void
Dispose of the resources.

Returns void
Implementation of IYText.dispose

Overrides YDocument.dispose
- Defined in src/yfile.ts:60

getSource

getSource(): string
Get the file text.

Returns
File text.

Returns string
Implementation of IYText.getSource

Overrides YDocument.getSource
- Defined in src/yfile.ts:73

getState

getState(key: string): undefined | JSONValue
Get the value for a state attribute
Parameters
- key: string
  
  Key to get
Returns undefined | JSONValue
Implementation of ISharedFile.getState

Inherited from YDocument.getState
- Defined in src/ydocument.ts:147

`Protected` onStateChanged

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

redo

redo(): boolean
Redo an operation.

Returns boolean
Implementation of IYText.redo

Inherited from YDocument.redo
- Defined in src/ydocument.ts:212

setSource

setSource(value: string): void
Set the file text.
Parameters
- value: string
  
  New text
Returns void
Implementation of IYText.setSource

Overrides YDocument.setSource
- Defined in src/yfile.ts:82

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 ISharedFile.setState

Inherited from YDocument.setState
- Defined in src/ydocument.ts:160

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 IYText.transact

Inherited from YDocument.transact
- Defined in src/ydocument.ts:231

undo

undo(): boolean
Undo an operation.

Returns boolean
Implementation of IYText.undo

Inherited from YDocument.undo
- Defined in src/ydocument.ts:201

updateSource

updateSource(start: number, end: number, value?: string): void
Replace content from start' to endwithvalue`.
Parameters
- start: number
- end: number
- value: string = ''
Returns void
Implementation of IYText.updateSource
- Defined in src/yfile.ts:97

`Static` create

create(): YFile
Creates a standalone YFile

Returns YFile
- Defined in src/yfile.ts:38

Generated using TypeDoc