Class: Doc

A Yjs instance handles the state of shared data.

Extends

Observable< string >

Constructors

constructor

new Doc(opts?): Doc

Parameters

Parameter	Type	Description
`opts`?	`DocOpts`	configuration

Returns

Doc

Overrides

Observable<string>.constructor

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/utils/Doc.d.ts:20

Properties

_item

_item: null | Item

If this document is a subdocument - a document integrated into another document - then _item is defined.

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/utils/Doc.d.ts:47

_observers

_observers: Map< string, any >

Some desc.

Defined In

node_modules/.pnpm/lib0@0.2.87/node_modules/lib0/observable.d.ts:58

Inherited from

Observable._observers

_transaction

_transaction: null | Transaction

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/utils/Doc.d.ts:34

_transactionCleanups

_transactionCleanups: Transaction[]

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/utils/Doc.d.ts:38

autoLoad

autoLoad: boolean

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/utils/Doc.d.ts:49

clientID

clientID: number

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/utils/Doc.d.ts:23

collectionid

collectionid: null | string

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/utils/Doc.d.ts:25

gc

gc: boolean

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/utils/Doc.d.ts:21

gcFilter

gcFilter: function

Parameters

Parameter	Type
`arg0`	`Item`

Returns

boolean

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/utils/Doc.d.ts:22

guid

guid: string

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/utils/Doc.d.ts:24

isLoaded

isLoaded: boolean

This is set to true when the persistence provider loaded the document from the database or when the sync event fires. Note that not all providers implement this feature. Provider authors are encouraged to fire the load event when the doc content is loaded from the database.

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/utils/Doc.d.ts:57

isSynced

isSynced: boolean

This is set to true when the connection provider has successfully synced with a backend. Note that when using peer-to-peer providers this event may not provide very useful. Also note that not all providers implement this feature. Provider authors are encouraged to fire the sync event when the doc has been synced (with true as a parameter) or if connection is lost (with false as a parameter).

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/utils/Doc.d.ts:65

shouldLoad

shouldLoad: boolean

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/utils/Doc.d.ts:48

store

store: StructStore

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/utils/Doc.d.ts:30

subdocs

subdocs: Set< Doc >

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/utils/Doc.d.ts:42

whenLoaded

whenLoaded: Promise< any >

Promise that resolves once the document has been loaded from a presistence provider.

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/utils/Doc.d.ts:69

whenSynced

whenSynced: Promise< any >

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/utils/Doc.d.ts:70

Methods

destroy

destroy(): void

Returns

void

Inherited from

Observable.destroy

Defined In

node_modules/.pnpm/lib0@0.2.87/node_modules/lib0/observable.d.ts:84

emit

emit(name, args): void

Emit a named event. All registered event listeners that listen to the specified name will receive the event.

Parameters

Parameter	Type	Description
`name`	`string`	The event name.
`args`	`any`[]	The arguments that are applied to the event listener.

Returns

void

Inherited from

Observable.emit

Todo

This should catch exceptions

Defined In

node_modules/.pnpm/lib0@0.2.87/node_modules/lib0/observable.d.ts:83

get

get(name, TypeConstructor?): AbstractType< any >

Define a shared data type.

Multiple calls of y.get(name, TypeConstructor) yield the same result and do not overwrite each other. I.e. y.define(name, Y.Array) === y.define(name, Y.Array)

After this method is called, the type is also available on y.share.get(name).

Best Practices: Define all types right after the Yjs instance is created and store them in a separate object. Also use the typed methods getText(name), getArray(name), ..

Parameters

Parameter	Type	Description
`name`	`string`	-
`TypeConstructor`?	`Function`	The constructor of the type definition. E.g. Y.Text, Y.Array, Y.Map, ...

Returns

AbstractType< any >

The created type. Constructed with TypeConstructor

Example

const y = new Y(..)
  const appState = {
    document: y.getText('document')
    comments: y.getArray('comments')
  }

const y = new Y(..)
  const appState = {
    document: y.getText('document')
    comments: y.getArray('comments')
  }

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/utils/Doc.d.ts:121

getArray

getArray<T_1>(name?): Array< T_1 >

Type parameters

Parameter
`T_1`

Parameters

Parameter	Type
`name`?	`string`

Returns

Array< T_1 >

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/utils/Doc.d.ts:129

getMap

getMap<T_2>(name?): Map< T_2 >

Type parameters

Parameter
`T_2`

Parameters

Parameter	Type
`name`?	`string`

Returns

Map< T_2 >

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/utils/Doc.d.ts:144

getSubdocGuids

getSubdocGuids(): Set< string >

Returns

Set< string >

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/utils/Doc.d.ts:80

getSubdocs

getSubdocs(): Set< Doc >

Returns

Set< Doc >

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/utils/Doc.d.ts:79

getText

getText(name?): Text

Parameters

Parameter	Type
`name`?	`string`

Returns

Text

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/utils/Doc.d.ts:136

getXmlFragment

getXmlFragment(name?): XmlFragment

Parameters

Parameter	Type
`name`?	`string`

Returns

XmlFragment

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/utils/Doc.d.ts:151

load

load(): void

Notify the parent document that you request to load data into this subdocument (if it is a subdocument).

load() might be used in the future to request any provider to load the most current data.

It is safe to call load() multiple times.

Returns

void

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/utils/Doc.d.ts:78

off

off(name, f): void

Parameters

Parameter	Type
`name`	`string`
`f`	`Function`

Returns

void

Inherited from

Observable.off

Defined In

node_modules/.pnpm/lib0@0.2.87/node_modules/lib0/observable.d.ts:73

on

on(eventName, f): void

Parameters

Parameter	Type
`eventName`	`string`
`f`	`function`

Returns

void

Overrides

Observable.on

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/utils/Doc.d.ts:167

once

once(name, f): void

Parameters

Parameter	Type
`name`	`string`
`f`	`Function`

Returns

void

Inherited from

Observable.once

Defined In

node_modules/.pnpm/lib0@0.2.87/node_modules/lib0/observable.d.ts:68

toJSON

toJSON(): object

Converts the entire document into a js object, recursively traversing each yjs type Doesn't log types that have not been defined (using ydoc.getType(..)).

Returns

object

Deprecated

Do not use this method and rather call toJSON directly on the shared types.

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/utils/Doc.d.ts:160

transact

transact<T>(f, origin?): T

Changes that happen inside of a transaction are bundled. This means that the observer fires after the transaction is finished and that all changes that happened inside of the transaction are sent as one message to the other peers.

Type parameters

Parameter
`T`

Parameters

Parameter	Type	Description
`f`	`function`	The function that should be executed as a transaction
`origin`?	`any`	Origin of who started the transaction. Will be stored on transaction.origin

Returns

T

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/utils/Doc.d.ts:94

Class: Doc ​

Extends ​

Constructors ​

constructor ​

Parameters ​

Returns ​

Overrides ​

Defined In ​

Properties ​

_item ​

Defined In ​

_observers ​

Defined In ​

Inherited from ​

_transaction ​

Defined In ​

_transactionCleanups ​

Defined In ​

autoLoad ​

Defined In ​

clientID ​

Defined In ​

collectionid ​

Defined In ​

gc ​

Defined In ​

gcFilter ​

Parameters ​

Returns ​

Defined In ​

guid ​

Defined In ​

isLoaded ​

Defined In ​

isSynced ​

Defined In ​

meta ​

Defined In ​

share ​

Defined In ​

shouldLoad ​

Defined In ​

store ​

Defined In ​

subdocs ​

Defined In ​

whenLoaded ​

Defined In ​

whenSynced ​

Defined In ​

Methods ​

destroy ​

Returns ​

Inherited from ​

Defined In ​

emit ​

Parameters ​

Returns ​

Inherited from ​

Todo ​

Defined In ​

get ​

Parameters ​

Returns ​

Example ​

Defined In ​

getArray ​

Type parameters ​

Parameters ​

Returns ​

Defined In ​

getMap ​

Type parameters ​

Parameters ​

Returns ​

Defined In ​

getSubdocGuids ​

Returns ​

Defined In ​

getSubdocs ​

Class: Doc

Extends

Constructors

constructor

Parameters

Returns

Overrides

Defined In

Properties

_item

Defined In

_observers

Defined In

Inherited from

_transaction

Defined In

_transactionCleanups

Defined In

autoLoad

Defined In

clientID

Defined In

collectionid

Defined In

gc

Defined In

gcFilter

Parameters

Returns

Defined In

guid

Defined In

isLoaded

Defined In

isSynced

Defined In

meta

Defined In

share

Defined In

shouldLoad

Defined In

store

Defined In

subdocs

Defined In

whenLoaded

Defined In

whenSynced

Defined In

Methods

destroy

Returns

Inherited from

Defined In

emit

Parameters

Returns

Inherited from

Todo

Defined In

get

Parameters

Returns

Example

Defined In

getArray

Type parameters

Parameters

Returns

Defined In

getMap

Type parameters

Parameters

Returns

Defined In

getSubdocGuids

Returns

Defined In

getSubdocs