# References

summary
public | C AbstractConnector |
public | C AbstractPersistence Abstract persistence class. |
public | C Transaction A transaction is created for every change on the Yjs model. |
public | C Y (room: string, opts: Object, persistence: AbstractPersistence) A Yjs instance handles the state of shared data. |
public | T encodable : number | string Anything that can be encoded with `JSON.stringify` and can be decoded with `JSON.parse`. |

## Bindings

summary
public | C Binding Abstract class for bindings. |

## Bindings/DomBinding

summary
public | C DomBinding A binding that binds the children of a YXmlFragment to a DOM element. |
public | F domToType (element: Element | TextNode, _document: Document, hooks: Hooks, filter: Filter, binding: DomBinding): YXmlElement | YXmlText Creates a Yjs type (YXml) based on the contents of a DOM Element. |
public | F defaultFilter (nodeName: String, attrs: Map): Map | null Default filter method (does nothing). |
public | F filterDomAttributes (dom: *, filter: *): * |
public | F createAssociation (domBinding: DomBinding, dom: Element, type: YXmlElement | YXmlHook) Creates an association (the information that a DOM element belongs to a type). |
public | F domsToTypes (doms: *, _document: *, hooks: *, filter: *, binding: *): * |
public | F removeAssociation (domBinding: DomBinding, dom: Element, type: YXmlElement | YXmlHook) Removes an association (the information that a DOM element belongs to a type). |
public | F switchAssociation (domBinding: DomBinding, oldDom: Element, newDom: Element) If oldDom is associated with a type, associate newDom with the type and forget about oldDom. |
public | T FilterFunction : function (nodeName: String, attrs: Map): Map | null A filter defines which elements and attributes to share. |

## Bindings/QuillBinding

summary
public | C QuillBinding A Binding that binds a YText type to a Quill editor. |

## Bindings/TextareaBinding

summary
public | C TextareaBinding A binding that binds a YText to a dom textarea. |

## MessageHandler

summary
public | F fromBinary (y: Y, decoder: BinaryDecoder) Read the Decoder and fill the Yjs instance with data in the decoder. |
public | F toBinary (y: Y): BinaryEncoder Encode the Yjs model to binary format. |
public | F readDeleteSet (y: *, decoder: *) |
public | F stringifyDeleteSet (y: *, decoder: *, strBuilder: *): * |
public | F writeDeleteSet (y: *, encoder: *) |
public | F integrateRemoteStructs (y: *, decoder: *) |
public | F stringifyStructs (y: *, decoder: *, strBuilder: *) |
public | F logID (id: *): string |
public | F messageToRoomname (buffer: *): * |
public | F messageToString (arrayPattern: *[]): * |
public | F readStateSet (decoder: *): * |
public | F writeStateSet (y: *, encoder: *) |
public | F readSyncStep1 (decoder: *, encoder: *, y: *, senderConn: *, sender: *) |
public | F sendSyncStep1 (connector: *, syncUser: *) |
public | F stringifySyncStep1 (y: *, decoder: *, strBuilder: *) |
public | F readSyncStep2 (decoder: *, encoder: *, y: *, senderConn: *, sender: *) |
public | F stringifySyncStep2 (y: *, decoder: *, strBuilder: *) |

## Store

summary
public | C DeleteStore |
public | C OperationStore |
public | C StateStore |

## Struct

summary
public | C GC |
public | C Item Abstract class that represents any content. |
public | C ItemEmbed |
public | C ItemFormat |
public | C ItemJSON |
public | C ItemString |
public | C Type Abstract Yjs Type class |
public | F getListItemIDByPosition (type: *, i: *): * |

## Types/YArray

summary
public | C YArray A shared Array implementation. |
public | C YArrayEvent (yarray: YArray, remote: Boolean, transaction: Transaction) Event that describes the changes on a YArray |

## Types/YMap

summary
public | C YMap A shared Map implementation. |
public | C YMapEvent (ymap: YMap, subs: Set<any>, remote: boolean) Event that describes the changes on a YMap. |

## Types/YText

summary
public | C YText (string: String) Type that represents text with formatting information. |
public | T Delta : Array<Object> The Quill Delta format represents changes on a text document with formatting information. |
public | T TextAttributes : Object Attributes that can be assigned to a selection of text. |

## Types/YXml

summary
public | C YXmlElement (nodeName: String) An YXmlElement imitates the behavior of a {@link https://developer.mozilla.org/en-US/docs/Web/API/Element|Dom Element}. |
public | C YXmlFragment Represents a list of YXmlElement.and YXmlText types. |
public | C YXmlHook You can manage binding to a custom type with YXmlHook. |
public | C YXmlText (arg1: String) Represents text in a Dom Element. |
public | C YXmlTreeWalker Represents a subset of the nodes of a YXmlElement / YXmlFragment and a position within them. |
public | T CSS_Selector : string Define the elements to which a set of CSS queries apply. |
public | T CSS_Selector : string Define the elements to which a set of CSS queries apply. |

## Util

summary
public | C EventHandler General event handler implementation. |
public | C NamedEventHandler Handles named events. |
public | C Tree |
public | C UndoManager Saves a history of locally applied operations. |
public | C YEvent YEvent describes the changes on a YType. |
public | F defragmentItemContent (y: *) Try to merge all items in os with their successors. |
public | F generateRandomUint32 (): * |
public | F isParentOf (parent: Type, child: Type): Boolean Check if `parent` is a parent of `child`. |
public | F createMutualExclude (): Function Creates a mutual exclude function with the following property: |
public | F fromRelativePosition (y: Y, rpos: RelativePosition): AbsolutePosition Transforms a relative position back to a relative position. |
public | F getRelativePosition (type: YType, offset: Integer): string [] Create a relativePosition based on a absolute position. |
public | F simpleDiff (a: String, b: String): SimpleDiff Create a diff between two strings. |
public | F registerStruct (reference: Number, structConstructor: class) Register a new Yjs types. |
public | T AbsolutePosition : Object |
public | T RelativePosition : encodable A relative position that is based on the Yjs model. |
public | T SimpleDiff : Object A SimpleDiff describes a change on a String. |

## Util/Binary

summary
public | C BinaryDecoder A BinaryDecoder handles the decoding of an ArrayBuffer. |
public | C BinaryEncoder A BinaryEncoder handles the encoding to an ArrayBuffer. |

## Util/ID

summary
public | C ID |
public | C RootID |
public | V RootFakeUserID : number |

Directories
Bindings
DomBinding
QuillBinding
TextareaBinding
MessageHandler
Store
Struct
YArray
YMap
YText
YXml
Util
Binary
ID