Extension declaration. Insert into the domain data to install the
extension. For example (assuming a m-ld clone object and a property
docText in the domain):
clone.write(TSeqText.declare(0, 'docText'));
the preferred index into the existing list of extensions (lower value is higher priority).
the properties to which to apply TSeq text behaviour
Generated using TypeDoc. Delivered by Vercel. @m-ld/m-ld - v0.10.0-edge.5 Source code licensed MIT. Privacy policy
This extension allows an app to embed collaborative text in a domain. When declared for a certain property with a string value, the string should be updated using the
@spliceoperator; and updates coming from the domain will also provide precise changes using@splice, as follows. The overall effect is that the string property can be manipulated concurrently by multiple users with the result being a merge of their edits (rather than an array of conflicting string values, as would otherwise be the case).The extension should be declared at runtime in the data using declare, or provided (combined with other plugins) during clone initialisation, e.g. for a hypothetical
docTextproperty:const meld = await clone(new MemoryLevel, IoRemotes, config, combinePlugins([ new TSeqText('docText'), ... ]));Once installed, a new document with text could be inserted:
await meld.write({ '@id': 'myDoc', docText: 'Initial text' });Changes to the document should be written using splice expressions in an
@update:await meld.write({ '@update': { '@id': 'myDoc', docText: { '@splice': [0, 7, 'My'] } });This update will be echoed by the local clone, also using the
@spliceoperator.This update changes the text "Initial" to "My". If a remote user updates "text" at position 8 to "words", at the same time, the update notification at this clone will correctly identify the change as happening at index position 3. Thus both clones will converge to "My words".
To generate splices, applications may consider the utility function textDiff.
To apply splices, applications may consider using updateSubject.
TSeq