etherpad-lite/doc/jsdoc/Changeset.md

364 lines
5.7 KiB
Markdown
Raw Normal View History

2011-05-30 16:53:11 +02:00
# Changeset
2011-05-29 22:30:56 +02:00
`require("./Changeset");`
2011-05-30 16:53:11 +02:00
## Functions
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### _slicerZipperFunc (attOp, csOp, opOut, pool)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **attOp** *No description*
* **csOp** *No description*
* **opOut** *No description*
* **pool** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### appendATextToAssembler (atext, assem)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **atext** *No description*
* **assem** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### applyToAText (cs, atext, pool)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **cs** *No description*
* **atext** *No description*
* **pool** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### applyToAttribution (cs, astr, pool)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **cs** *No description*
* **astr** *No description*
* **pool** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### applyToText (cs, str)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **cs** *No description*
* **str** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### applyZip (in1, idx1, in2, idx2, func)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **in1** *No description*
* **idx1** *No description*
* **in2** *No description*
* **idx2** *No description*
* **func** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### attribsAttributeValue (attribs, key, pool)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **attribs** *No description*
* **key** *No description*
* **pool** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### attributeTester (attribPair, pool)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **attribPair** *No description*
* **pool** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### builder (oldLen)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **oldLen** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### characterRangeFollow (cs, startChar, endChar, insertionsAfter)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **cs** *No description*
* **startChar** *No description*
* **endChar** *No description*
* **insertionsAfter** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### checkRep (cs)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **cs** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### clearOp (op)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **op** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### cloneAText (atext)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **atext** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### cloneOp (op)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **op** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### compose (cs1, cs2, pool)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **cs1** *No description*
* **cs2** *No description*
* **pool** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### composeAttributes (att1, att2, resultIsMutation, pool)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **att1** *No description*
* **att2** *No description*
* **resultIsMutation** *No description*
* **pool** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### copyAText (atext1, atext2)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **atext1** *No description*
* **atext2** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### copyOp (op1, op2)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **op1** *No description*
* **op2** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### eachAttribNumber (cs, func)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **cs** *No description*
* **func** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### filterAttribNumbers (cs, filter)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **cs** *No description*
* **filter** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### follow (cs1, cs2, reverseInsertOrder, pool)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **cs1** *No description*
* **cs2** *No description*
* **reverseInsertOrder** *No description*
* **pool** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### followAttributes (att1, att2, pool)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **att1** *No description*
* **att2** *No description*
* **pool** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### identity (N)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **N** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### inverse (cs, lines, alines, pool)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **cs** *No description*
* **lines** *No description*
* **alines** *No description*
* **pool** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### isIdentity (cs)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **cs** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### joinAttributionLines (theAlines)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **theAlines** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### makeAText (text, attribs)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **text** *No description*
* **attribs** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### makeAttribsString (opcode, attribs, pool)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **opcode** *No description*
* **attribs** *No description*
* **pool** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### makeAttribution (text)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **text** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### makeSplice (oldFullText, spliceStart, numRemoved, newText, optNewTextAPairs, pool)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **oldFullText** *No description*
* **spliceStart** *No description*
* **numRemoved** *No description*
* **newText** *No description*
* **optNewTextAPairs** *No description*
* **pool** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### mapAttribNumbers (cs, func)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **cs** *No description*
* **func** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### mergingOpAssembler ()
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### moveOpsToNewPool (cs, oldPool, newPool)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **cs** *No description*
* **oldPool** *No description*
* **newPool** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### mutateAttributionLines (cs, lines, pool)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **cs** *No description*
* **lines** *No description*
* **pool** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### mutateTextLines (cs, lines)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **cs** *No description*
* **lines** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### newLen (cs)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **cs** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### newOp (optOpcode)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **optOpcode** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### numToString (num)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **num** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### oldLen (cs)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **cs** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### oneInsertedLineAtATimeOpIterator (opsStr, optStartIndex, charBank)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **opsStr** *No description*
* **optStartIndex** *No description*
* **charBank** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### opAssembler ()
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### opAttributeValue (op, key, pool)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **op** *No description*
* **key** *No description*
* **pool** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### opIterator (opsStr, optStartIndex)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **opsStr** *No description*
* **optStartIndex** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### opString (op)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **op** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### pack (oldLen, newLen, opsStr, bank)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **oldLen** *No description*
* **newLen** *No description*
* **opsStr** *No description*
* **bank** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### parseNum (str)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **str** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### prepareForWire (cs, pool)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **cs** *No description*
* **pool** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### smartOpAssembler ()
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### splitAttributionLines (attrOps, text)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **attrOps** *No description*
* **text** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### splitTextLines (text)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **text** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### stringAssembler ()
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### stringIterator (str)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **str** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### stringOp (str)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **str** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### subattribution (astr, start, optEnd)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **astr** *No description*
* **start** *No description*
* **optEnd** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### textLinesMutator (lines)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **lines** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### toBaseTen (cs)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **cs** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### toSplices (cs)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **cs** *No description*
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### unpack (cs)
2011-05-29 22:30:56 +02:00
2011-05-30 16:53:11 +02:00
* **cs** *No description*
2011-05-29 22:30:56 +02:00
##Variables
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### assert
2011-05-29 22:30:56 +02:00
2011-05-30 17:05:42 +02:00
- - -
2011-05-30 16:53:11 +02:00
### error
2011-05-29 22:30:56 +02:00