@y/y
Version:
Shared Editing Library
199 lines • 8.69 kB
TypeScript
/**
* @typedef {Object} DocOpts
* @property {boolean} [DocOpts.gc=true] Disable garbage collection (default: gc=true)
* @property {function(Item):boolean} [DocOpts.gcFilter] Will be called before an Item is garbage collected. Return false to keep the Item.
* @property {string} [DocOpts.guid] Define a globally unique identifier for this document
* @property {string | null} [DocOpts.collectionid] Associate this document with a collection. This only plays a role if your provider has a concept of collection.
* @property {any} [DocOpts.meta] Any kind of meta information you want to associate with this document. If this is a subdocument, remote peers will store the meta information as well.
* @property {boolean} [DocOpts.autoLoad] If a subdocument, automatically load document. If this is a subdocument, remote peers will load the document as well automatically.
* @property {boolean} [DocOpts.shouldLoad] Whether the document should be synced by the provider now. This is toggled to true when you call ydoc.load()
* @property {boolean} [DocOpts.isSuggestionDoc] Set to true if this document merely suggests
* changes. If this flag is not set in a suggestion document, automatic formatting changes will be
* displayed as suggestions, which might not be intended.
*/
/**
* @typedef {Object} DocEvents
* @property {function(Doc):void} DocEvents.destroy
* @property {function(Doc):void} DocEvents.load
* @property {function(boolean, Doc):void} DocEvents.sync
* @property {function(Uint8Array<ArrayBuffer>, any, Doc, Transaction):void} DocEvents.update
* @property {function(Uint8Array<ArrayBuffer>, any, Doc, Transaction):void} DocEvents.updateV2
* @property {function(Doc):void} DocEvents.beforeAllTransactions
* @property {function(Transaction, Doc):void} DocEvents.beforeTransaction
* @property {function(Transaction, Doc):void} DocEvents.beforeObserverCalls
* @property {function(Transaction, Doc):void} DocEvents.afterTransaction
* @property {function(Transaction, Doc):void} DocEvents.afterTransactionCleanup
* @property {function(Doc, Array<Transaction>):void} DocEvents.afterAllTransactions
* @property {function({ loaded: Set<Doc>, added: Set<Doc>, removed: Set<Doc> }, Doc, Transaction):void} DocEvents.subdocs
*/
/**
* A Yjs instance handles the state of shared data.
* @extends ObservableV2<DocEvents>
*/
export class Doc extends ObservableV2<DocEvents> {
/**
* @param {DocOpts} opts configuration
*/
constructor({ guid, collectionid, gc, gcFilter, meta, autoLoad, shouldLoad, isSuggestionDoc }?: DocOpts);
gc: boolean;
gcFilter: (arg0: Item) => boolean;
clientID: number;
guid: string;
collectionid: string | null;
isSuggestionDoc: boolean;
cleanupFormatting: boolean;
/**
* @type {Map<string, YType>}
*/
share: Map<string, YType>;
store: StructStore;
/**
* @type {Transaction | null}
*/
_transaction: Transaction | null;
/**
* @type {Array<Transaction>}
*/
_transactionCleanups: Array<Transaction>;
/**
* @type {Set<Doc>}
*/
subdocs: Set<Doc>;
/**
* If this document is a subdocument - a document integrated into another document - then _item is defined.
* @type {Item?}
*/
_item: Item | null;
shouldLoad: boolean;
autoLoad: boolean;
meta: any;
/**
* 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.
*
* @type {boolean}
*/
isLoaded: 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).
*/
isSynced: boolean;
isDestroyed: boolean;
/**
* Promise that resolves once the document has been loaded from a persistence provider.
*/
whenLoaded: Promise<any>;
whenSynced: Promise<any>;
/**
* 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.
*/
load(): void;
getSubdocs(): Set<Doc>;
getSubdocGuids(): Set<string>;
/**
* 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.
*
* @template T
* @param {function(Transaction):T} f The function that should be executed as a transaction
* @param {any} [origin] Origin of who started the transaction. Will be stored on transaction.origin
* @param {boolean} [local]
* @return T
*/
transact<T>(f: (arg0: Transaction) => T, origin?: any, local?: boolean): T;
/**
* Define a shared data type.
*
* Multiple calls of `ydoc.get(name)` yield the same result
* and do not overwrite each other. I.e.
* `ydoc.get(name) === ydoc.get(name)`
*
* After this method is called, the type is also available on `ydoc.share.get(name)`.
*
* @param {string} key
* @param {string?} name Type-name
*
* @return {YType}
*/
get(key?: string, name?: string | null): YType;
/**
* 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(..)).
*
* @deprecated Do not use this method and rather call toJSON directly on the shared types.
*
* @return {Object<string, any>}
*/
toJSON(): {
[x: string]: any;
};
$type: import("lib0/schema").Schema<Doc>;
}
export type DocOpts = {
/**
* Disable garbage collection (default: gc=true)
*/
gc?: boolean | undefined;
/**
* Will be called before an Item is garbage collected. Return false to keep the Item.
*/
gcFilter?: ((arg0: Item) => boolean) | undefined;
/**
* Define a globally unique identifier for this document
*/
guid?: string | undefined;
/**
* Associate this document with a collection. This only plays a role if your provider has a concept of collection.
*/
collectionid?: string | null | undefined;
/**
* Any kind of meta information you want to associate with this document. If this is a subdocument, remote peers will store the meta information as well.
*/
meta?: any;
/**
* If a subdocument, automatically load document. If this is a subdocument, remote peers will load the document as well automatically.
*/
autoLoad?: boolean | undefined;
/**
* Whether the document should be synced by the provider now. This is toggled to true when you call ydoc.load()
*/
shouldLoad?: boolean | undefined;
/**
* Set to true if this document merely suggests
* changes. If this flag is not set in a suggestion document, automatic formatting changes will be
* displayed as suggestions, which might not be intended.
*/
isSuggestionDoc?: boolean | undefined;
};
export type DocEvents = {
destroy: (arg0: Doc) => void;
load: (arg0: Doc) => void;
sync: (arg0: boolean, arg1: Doc) => void;
update: (arg0: Uint8Array<ArrayBuffer>, arg1: any, arg2: Doc, arg3: Transaction) => void;
updateV2: (arg0: Uint8Array<ArrayBuffer>, arg1: any, arg2: Doc, arg3: Transaction) => void;
beforeAllTransactions: (arg0: Doc) => void;
beforeTransaction: (arg0: Transaction, arg1: Doc) => void;
beforeObserverCalls: (arg0: Transaction, arg1: Doc) => void;
afterTransaction: (arg0: Transaction, arg1: Doc) => void;
afterTransactionCleanup: (arg0: Transaction, arg1: Doc) => void;
afterAllTransactions: (arg0: Doc, arg1: Array<Transaction>) => void;
subdocs: (arg0: {
loaded: Set<Doc>;
added: Set<Doc>;
removed: Set<Doc>;
}, arg1: Doc, arg2: Transaction) => void;
};
import { ObservableV2 } from 'lib0/observable';
import { YType } from '../ytype.js';
import { StructStore } from './StructStore.js';
//# sourceMappingURL=Doc.d.ts.map