Comparing version 0.15.0 to 0.16.0
@@ -8,3 +8,3 @@ { | ||
"description": "High performance implementation of the Yjs CRDT", | ||
"version": "0.15.0", | ||
"version": "0.16.0", | ||
"license": "MIT", | ||
@@ -11,0 +11,0 @@ "repository": { |
129
ywasm.d.ts
@@ -189,3 +189,38 @@ /* tslint:disable */ | ||
/** | ||
* Retrieves a sticky index corresponding to a given human-readable `index` pointing into | ||
* the shared `ytype`. Unlike standard indexes sticky indexes enables to track | ||
* the location inside of a shared y-types, even in the face of concurrent updates. | ||
* | ||
* If association is >= 0, the resulting position will point to location **after** the referenced index. | ||
* If association is < 0, the resulting position will point to location **before** the referenced index. | ||
* @param {any} ytype | ||
* @param {number} index | ||
* @param {number} assoc | ||
* @param {YTransaction | null = null} txn | ||
* @returns {any} | ||
*/ | ||
export function createStickyIndexFromType(ytype: any, index: number, assoc: number, txn: YTransaction | null = null): any; | ||
/** | ||
* Converts a sticky index (see: `createStickyIndexFromType`) into an object | ||
* containing human-readable index. | ||
* @param {any} rpos | ||
* @param {YDoc} doc | ||
* @returns {any} | ||
*/ | ||
export function createOffsetFromStickyIndex(rpos: any, doc: YDoc): any; | ||
/** | ||
* Serializes sticky index created by `createStickyIndexFromType` into a binary | ||
* payload. | ||
* @param {any} rpos | ||
* @returns {Uint8Array} | ||
*/ | ||
export function encodeStickyIndex(rpos: any): Uint8Array; | ||
/** | ||
* Deserializes sticky index serialized previously by `encodeStickyIndex`. | ||
* @param {Uint8Array} bin | ||
* @returns {any} | ||
*/ | ||
export function decodeStickyIndex(bin: Uint8Array): any; | ||
/** | ||
*/ | ||
export class YAfterTransactionEvent { | ||
@@ -196,3 +231,2 @@ free(): void; | ||
* time descriptor at the moment when transaction was comitted. | ||
* @returns {Map<any, any>} | ||
*/ | ||
@@ -204,3 +238,2 @@ readonly afterState: Map<any, any>; | ||
* made in scope of this transaction. | ||
* @returns {Map<any, any>} | ||
*/ | ||
@@ -211,3 +244,2 @@ readonly beforeState: Map<any, any>; | ||
* of all blocks deleted as part of current transaction. | ||
* @returns {Map<any, any>} | ||
*/ | ||
@@ -349,3 +381,2 @@ readonly deleteSet: Map<any, any>; | ||
* document store and cannot be nested again: attempt to do so will result in an exception. | ||
* @returns {boolean} | ||
*/ | ||
@@ -372,3 +403,2 @@ readonly prelim: boolean; | ||
* - { retain: number } | ||
* @returns {any} | ||
*/ | ||
@@ -378,3 +408,2 @@ readonly delta: any; | ||
* Returns a current shared type instance, that current event changes refer to. | ||
* @returns {any} | ||
*/ | ||
@@ -634,3 +663,2 @@ readonly target: any; | ||
/** | ||
* @returns {boolean} | ||
*/ | ||
@@ -640,3 +668,2 @@ readonly autoLoad: boolean; | ||
* Gets globally unique identifier of this `YDoc` instance. | ||
* @returns {string} | ||
*/ | ||
@@ -646,3 +673,2 @@ readonly guid: string; | ||
* Gets unique peer identifier of this `YDoc` instance. | ||
* @returns {number} | ||
*/ | ||
@@ -652,7 +678,5 @@ readonly id: number; | ||
* Returns a parent document of this document or null if current document is not sub-document. | ||
* @returns {YDoc | undefined} | ||
*/ | ||
readonly parentDoc: YDoc | undefined; | ||
/** | ||
* @returns {boolean} | ||
*/ | ||
@@ -667,15 +691,2 @@ readonly shouldLoad: boolean; | ||
/** | ||
*/ | ||
export class YID { | ||
free(): void; | ||
/** | ||
* @returns {BigInt} | ||
*/ | ||
readonly client: BigInt; | ||
/** | ||
* @returns {number} | ||
*/ | ||
readonly clock: number; | ||
} | ||
/** | ||
* Collection used to store key-value entries in an unordered manner. Keys are always represented | ||
@@ -787,3 +798,2 @@ * as UTF-8 strings. Values can be any value type supported by Yrs: JSON-like primitives as well as | ||
* document store and cannot be nested again: attempt to do so will result in an exception. | ||
* @returns {boolean} | ||
*/ | ||
@@ -808,3 +818,2 @@ readonly prelim: boolean; | ||
* - { action: 'add'|'update'|'delete', oldValue: any|undefined, newValue: any|undefined } | ||
* @returns {any} | ||
*/ | ||
@@ -814,3 +823,2 @@ readonly keys: any; | ||
* Returns a current shared type instance, that current event changes refer to. | ||
* @returns {any} | ||
*/ | ||
@@ -837,11 +845,8 @@ readonly target: any; | ||
/** | ||
* @returns {any} | ||
*/ | ||
readonly added: any; | ||
/** | ||
* @returns {any} | ||
*/ | ||
readonly loaded: any; | ||
/** | ||
* @returns {any} | ||
*/ | ||
@@ -986,3 +991,2 @@ readonly removed: any; | ||
* document store and cannot be nested again: attempt to do so will result in an exception. | ||
* @returns {boolean} | ||
*/ | ||
@@ -1009,3 +1013,2 @@ readonly prelim: boolean; | ||
* - { retain: number, attributes: any|undefined } | ||
* @returns {any} | ||
*/ | ||
@@ -1015,3 +1018,2 @@ readonly delta: any; | ||
* Returns a current shared type instance, that current event changes refer to. | ||
* @returns {any} | ||
*/ | ||
@@ -1057,12 +1059,2 @@ readonly target: any; | ||
/** | ||
* Returns true if current transaction can be used only for read operations. | ||
* @returns {boolean} | ||
*/ | ||
isReadOnly(): boolean; | ||
/** | ||
* Returns true if current transaction can be used only for updating the document store. | ||
* @returns {boolean} | ||
*/ | ||
isWriteable(): boolean; | ||
/** | ||
* Triggers a post-update series of operations without `free`ing the transaction. This includes | ||
@@ -1235,5 +1227,12 @@ * compaction and optimization of internal representation of updates, triggering events etc. | ||
/** | ||
* Returns true if current transaction can be used only for read operations. | ||
*/ | ||
readonly isReadOnly: boolean; | ||
/** | ||
* Returns true if current transaction can be used only for updating the document store. | ||
* @returns {any} | ||
*/ | ||
readonly isWriteable: boolean; | ||
/** | ||
* Returns true if current transaction can be used only for updating the document store. | ||
*/ | ||
readonly origin: any; | ||
@@ -1246,11 +1245,8 @@ } | ||
/** | ||
* @returns {any} | ||
*/ | ||
readonly kind: any; | ||
/** | ||
* @returns {any} | ||
*/ | ||
readonly origin: any; | ||
/** | ||
* @returns {any} | ||
*/ | ||
@@ -1294,10 +1290,2 @@ readonly stackItem: any; | ||
/** | ||
* @returns {boolean} | ||
*/ | ||
canUndo(): boolean; | ||
/** | ||
* @returns {boolean} | ||
*/ | ||
canRedo(): boolean; | ||
/** | ||
* @param {Function} callback | ||
@@ -1312,2 +1300,8 @@ * @returns {YUndoObserver} | ||
onStackItemPopped(callback: Function): YUndoObserver; | ||
/** | ||
*/ | ||
readonly canRedo: boolean; | ||
/** | ||
*/ | ||
readonly canUndo: boolean; | ||
} | ||
@@ -1406,7 +1400,2 @@ /** | ||
/** | ||
* Returns a parent `YXmlElement` node or `undefined` if current node has no parent assigned. | ||
* @returns {any} | ||
*/ | ||
parent(): any; | ||
/** | ||
* Returns a string representation of this XML node. | ||
@@ -1472,5 +1461,8 @@ * @param {YTransaction | null = null} txn | ||
* Returns a tag name of this XML node. | ||
* @returns {string} | ||
*/ | ||
readonly name: string; | ||
/** | ||
* Returns a parent `YXmlElement` node or `undefined` if current node has no parent assigned. | ||
*/ | ||
readonly parent: any; | ||
} | ||
@@ -1495,3 +1487,2 @@ /** | ||
* - { retain: number } | ||
* @returns {any} | ||
*/ | ||
@@ -1504,3 +1495,2 @@ readonly delta: any; | ||
* - { action: 'add'|'update'|'delete', oldValue: string|undefined, newValue: string|undefined } | ||
* @returns {any} | ||
*/ | ||
@@ -1510,3 +1500,2 @@ readonly keys: any; | ||
* Returns a current shared type instance, that current event changes refer to. | ||
* @returns {any} | ||
*/ | ||
@@ -1701,7 +1690,2 @@ readonly target: any; | ||
/** | ||
* Returns a parent `YXmlElement` node or `undefined` if current node has no parent assigned. | ||
* @returns {any} | ||
*/ | ||
parent(): any; | ||
/** | ||
* Returns an underlying string stored in this `YXmlText` instance. | ||
@@ -1758,2 +1742,6 @@ * @param {YTransaction | null = null} txn | ||
observeDeep(f: Function): YEventObserver; | ||
/** | ||
* Returns a parent `YXmlElement` node or `undefined` if current node has no parent assigned. | ||
*/ | ||
readonly parent: any; | ||
} | ||
@@ -1778,3 +1766,2 @@ /** | ||
* - { retain: number, attributes: any|undefined } | ||
* @returns {any} | ||
*/ | ||
@@ -1787,3 +1774,2 @@ readonly delta: any; | ||
* - { action: 'add'|'update'|'delete', oldValue: string|undefined, newValue: string|undefined } | ||
* @returns {any} | ||
*/ | ||
@@ -1793,3 +1779,2 @@ readonly keys: any; | ||
* Returns a current shared type instance, that current event changes refer to. | ||
* @returns {any} | ||
*/ | ||
@@ -1796,0 +1781,0 @@ readonly target: any; |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
1068487
5622