@dittolive/ditto 4.8.2 → 4.8.4-rc.1

package/types/ditto.d.ts

@@ -547,6 +547,8 @@ declare class NotAvailableAuthenticator extends Authenticator {
 /**
  * Represents a CRDT counter that can be upserted as part of a document or
  * assigned to a property during an update of a document.
+ *
+ * Not available in React Native environments.
  */
 declare class Counter {
     /** The value of the counter. */
@@ -576,6 +578,8 @@ declare class MutableCounter extends Counter {
      * {@link PendingCursorOperation.update | PendingCursorOperation.update()} and
      * {@link PendingIDSpecificOperation.update | PendingIDSpecificOperation.update()},
      * otherwise an exception is thrown.
+     *
+     * @throws {Error} when called in a React Native environment.
      */
     increment(amount: number): void;
     /** @internal */
@@ -585,6 +589,8 @@ declare class MutableCounter extends Counter {
 /**
  * Represents a CRDT register that can be upserted as part of a document or
  * assigned to a property during an update of a document.
+ *
+ * Not available in React Native environments.
  */
 declare class Register {
     /** Returns the value of the register. */
@@ -607,13 +613,22 @@ declare class Register {
  * updating a document.
  *
  * This class can't be instantiated directly, it's returned automatically for
- * any register property of a document within an update block via {@link MutableDocumentPath.register}.
+ * any register property of a document within an update block via
+ * {@link MutableDocumentPath.register}.
+ *
+ * Not available in React Native environments.
  */
 declare class MutableRegister extends Register {
-    /** Returns the value of the register. */
+    /**
+     * Returns the value of the register.
+     *
+     * Not available in React Native environments.
+     */
     get value(): any;
     /**
      * Convenience setter, equivalent to {@link set | set()}.
+     *
+     * Not available in React Native environments.
      */
     set value(value: any);
     /**
@@ -623,6 +638,8 @@ declare class MutableRegister extends Register {
      * {@link PendingCursorOperation.update | PendingCursorOperation.update()} and
      * {@link PendingIDSpecificOperation.update | PendingIDSpecificOperation.update()},
      * otherwise an exception is thrown.
+     *
+     * Not available in React Native environments.
      */
     set(value: any): void;
     /** @internal */
@@ -686,6 +703,8 @@ declare class AttachmentToken {
  * type. You don't create a `DocumentPath` directly but obtain one via the
  * {@link Document.path | path} property or the {@link Document.at | at()}
  * method of {@link Document}.
+ *
+ * Not available in React Native environments.
  */
 declare class DocumentPath {
     /** The document this path belongs to. */
@@ -710,26 +729,36 @@ declare class DocumentPath {
      *    - `documentPath.at('passengers[2]')`
      *    - `documentPath.at('passengers[2].belongings[1].kind')`
      *    - `documentPath.at('.mileage')`
+     *
+     * @throws {Error} when called in a React Native environment.
      */
     at(keyPathOrIndex: string | number): DocumentPath;
     /**
      * Traverses the document with the key-path represented by the receiver and
      * returns the corresponding object or value.
+     *
+     * @throws {Error} when called in a React Native environment.
      */
     get value(): any | undefined;
     /**
      * Returns the value at the previously specified key in the document as a
      * {@link Counter} if possible, otherwise returns `null`.
+     *
+     * @throws {Error} when called in a React Native environment.
      */
     get counter(): Counter | null;
     /**
      * Returns the value at the previously specified key in the document as a
      * {@link Register} if possible, otherwise returns `null`.
+     *
+     * @throws {Error} when called in a React Native environment.
      */
     get register(): Register | null;
     /**
      * Returns the value at the previously specified key in the document as an
      * {@link AttachmentToken} if possible, otherwise returns `null`.
+     *
+     * @throws {Error} when called in a React Native environment.
      */
     get attachmentToken(): AttachmentToken | null;
     /** @internal */
@@ -742,6 +771,8 @@ declare class DocumentPath {
  * a specific key-path. You don't create a `MutableDocumentPath` directly but
  * obtain one via the {@link MutableDocument.path | path} property or the
  * {@link MutableDocument.at | at()} method of {@link MutableDocument}.
+ *
+ * Not available in React Native environments.
  */
 declare class MutableDocumentPath {
     /** The (mutable) document this path belongs to. */
@@ -766,26 +797,36 @@ declare class MutableDocumentPath {
      *    - `mutableDocumentPath.at('passengers[2]')`
      *    - `mutableDocumentPath.at('passengers[2].belongings[1].kind')`
      *    - `mutableDocumentPath.at('.mileage')`
+     *
+     * @throws {Error} when called in a React Native environment.
      */
     at(keyPathOrIndex: string | number): MutableDocumentPath;
     /**
      * Traverses the document with the key-path represented by the receiver and
      * returns the corresponding object or value.
+     *
+     * @throws {Error} when called in a React Native environment.
      */
     get value(): any | undefined;
     /**
      * Returns the value at the previously specified key in the document as a
      * {@link MutableCounter} if possible, otherwise returns `null`.
+     *
+     * @throws {Error} when called in a React Native environment.
      */
     get counter(): MutableCounter | null;
     /**
      * Returns the value at the previously specified key in the document as a
      * {@link MutableRegister} if possible, otherwise returns `null`.
+     *
+     * @throws {Error} when called in a React Native environment.
      */
     get register(): MutableRegister | null;
     /**
      * Returns the value at the previously specified key in the document as a
      * {@link AttachmentToken} if possible, otherwise returns `null`.
+     *
+     * @throws {Error} when called in a React Native environment.
      */
     get attachmentToken(): AttachmentToken | null;
     /**
@@ -795,10 +836,14 @@ declare class MutableDocumentPath {
      * default value. Set this to `true` if you want to set a default value that
      * you expect to be overwritten by other devices in the network. The default
      * value is `false`.
+     *
+     * @throws {Error} when called in a React Native environment.
      */
     set(value: any, isDefault?: boolean): void;
     /**
      * Removes a value at the document's key-path defined by the receiver.
+     *
+     * @throws {Error} when called in a React Native environment.
      */
     remove(): void;
     /** @internal */
@@ -828,6 +873,8 @@ type UpdateResultType = 'set' | 'incremented' | 'removed';
  *   - `set`
  *   - `removed`
  *   - `incremented`
+ *
+ * Not available in React Native environments.
  */
 declare class UpdateResult {
     /** The update result's type. */
@@ -864,33 +911,49 @@ declare const CUSTOM_INSPECT_SYMBOL$1: unique symbol;
  * `-Infinity`).
  */
 type DocumentValue = Record<string, any>;
-/** A document belonging to a {@link Collection} with an inner value. */
+/**
+ * A document belonging to a {@link Collection} with an inner value.
+ *
+ * Not available in React Native environments.
+ */
 declare class Document {
     /**
      * Returns a hash that represents the passed in document(s).
+     *
+     * @throws {Error} when called in a React Native environment.
      */
     static hash(documentOrMany: Document | Document[]): BigInt;
     /**
      * Returns a pattern of words that together create a mnemonic, which
      * represents the passed in document(s).
+     *
+     * @throws {Error} when called in a React Native environment.
      */
     static hashMnemonic(documentOrMany: Document | Document[]): string;
     /**
      * Returns the document ID.
+     *
+     * @throws {Error} when called in a React Native environment.
      */
     get id(): DocumentID;
     /**
      * Returns the document path at the root of the document.
+     *
+     * @throws {Error} when called in a React Native environment.
      */
     get path(): DocumentPath;
     /**
      * Convenience property, same as calling `path.value`. The value is cached on
      * first access and returned on subsequent calls without calling `path.value`
      * again.
+     *
+     * @throws {Error} when called in a React Native environment.
      */
     get value(): DocumentValue;
     /**
      * Convenience method, same as calling `path.at()`.
+     *
+     * @throws {Error} when called in a React Native environment.
      */
     at(keyPathOrIndex: string | number): DocumentPath;
     /** @internal */
@@ -917,22 +980,32 @@ declare class Document {
  * `MutableDocument` directly but rather through the `update()` methods of
  * {@link PendingCursorOperation.update | PendingCursorOperation} and
  * {@link PendingIDSpecificOperation.update | PendingIDSpecificOperation}.
+ *
+ * Not available in React Native environments.
  */
 declare class MutableDocument {
     /**
      * Returns the ID of the document.
+     *
+     * @throws {Error} when called in a React Native environment.
      */
     get id(): DocumentID;
     /**
      * Returns the document path at the root of the document.
+     *
+     * @throws {Error} when called in a React Native environment.
      */
     get path(): MutableDocumentPath;
     /**
      * Convenience property, same as `path.value`.
+     *
+     * @throws {Error} when called in a React Native environment.
      */
     get value(): DocumentValue;
     /**
      * Convenience method, same as calling `path.at()`.
+     *
+     * @throws {Error} when called in a React Native environment.
      */
     at(keyPathOrIndex: string | number): MutableDocumentPath;
     /** @internal */
@@ -1864,6 +1937,11 @@ declare class SubscriptionManager {
  * While {@link Subscription} objects remain in scope they ensure that
  * documents in the collection specified and that match the query provided will
  * try to be kept up-to-date with the latest changes from remote peers.
+ *
+ * This class is used by Ditto's query builder APIs.
+ * @see {@link SyncSubscription} for the DQL equivalent.
+ *
+ * Not available in React Native environments.
  */
 declare class Subscription {
     /**
@@ -1932,6 +2010,8 @@ declare class LiveQueryManager {
  * your event handler be called when there is an update to a document matching
  * the query you provide. When you no longer want to receive updates about
  * documents matching a query then you must call {@link stop | stop()}.
+ *
+ * Not available in React Native environments.
  */
 declare class LiveQuery {
     /** The query that the live query is based on. */
@@ -1944,6 +2024,8 @@ declare class LiveQuery {
     get isStopped(): boolean;
     /**
      * Stop the live query from delivering updates.
+     *
+     * @throws {Error} when called in a React Native environment.
      */
     stop(): void;
     /** @internal */
@@ -1976,6 +2058,8 @@ declare class LiveQuery {
  * {@link UpdateResult | update results}. This is the data structure you get
  * when {@link PendingCursorOperation.update | updating} a set of documents
  * with detailed info about the performed updates.
+ *
+ * Not available in React Native environments.
  */
 declare class UpdateResultsMap {
     /**
@@ -2003,11 +2087,14 @@ declare class UpdateResultsMap {
  * return value, or chain calls to update, evict or remove the document.
  *
  * Live queries and subscriptions are only available outside of a transaction.
+ *
+ * Not available in React Native environments.
  */
 declare abstract class BasePendingIDSpecificOperation implements PromiseLike<Document | undefined> {
     /**
      * Removes the document with the matching ID.
      *
+     * @throws {Error} when called in a React Native environment.
      * @returns `true` promise if the document was found and removed. `false`
      * promise if the document wasn't found and therefore wasn't removed.
      */
@@ -2015,6 +2102,7 @@ declare abstract class BasePendingIDSpecificOperation implements PromiseLike<Doc
     /**
      * Evicts the document with the matching ID.
      *
+     * @throws {Error} when called in a React Native environment.
      * @returns `true` promise if the document was found and evicted. `false`
      * promise if the document wasn't found and therefore wasn't evicted.
      */
@@ -2030,6 +2118,7 @@ declare abstract class BasePendingIDSpecificOperation implements PromiseLike<Doc
      * update-related functions on it. If the document is not found then the value
      * provided to the closure will be `undefined`.
      *
+     * @throws {Error} when called in a React Native environment.
      * @return An array promise of {@link UpdateResult | update results} that
      * describe the updates that were performed on the document.
      */
@@ -2041,6 +2130,7 @@ declare abstract class BasePendingIDSpecificOperation implements PromiseLike<Doc
     /**
      * Executes the find operation to return the document with the matching ID.
      *
+     * @throws {Error} when called in a React Native environment.
      * @returns The {@link Document} promise with the ID provided in the
      * {@link Collection.findByID | findByID()} call or `undefined` if the document was
      * not found.
@@ -2076,11 +2166,14 @@ interface CollectionInterface {
      * @param query The query to run against the collection.
      * @param queryArgs These arguments replace placeholders in the provided
      * query.
+     * @throws {Error} when called in a React Native environment.
      */
     find(query: string, queryArgs?: QueryArguments): BasePendingCursorOperation;
     /**
      * Convenience method, equivalent to calling {@link find | find()} and passing
      * the query `"true"`.
+     *
+     * @throws {Error} when called in a React Native environment.
      */
     findAll(): BasePendingCursorOperation;
     /**
@@ -2089,6 +2182,7 @@ interface CollectionInterface {
      * Use the returned cursor instance to chain operations on the search result.
      *
      * @param id The document's identifier
+     * @throws {Error} when called in a React Native environment.
      */
     findByID(id: DocumentID | DocumentIDValue): BasePendingIDSpecificOperation;
     /**
@@ -2107,15 +2201,20 @@ interface CollectionInterface {
      * not contain any non-finite numbers (NaN, Infinity, -Infinity).
      * @param options Change defaults for the behavior of the operation, such as
      * the write strategy.
+     * @throws {Error} when called in a React Native environment.
      */
     upsert(value: DocumentValue, options: UpsertOptions): Promise<DocumentID>;
 }
 
+/**
+ * Not available in React Native environments.
+ */
 declare abstract class BasePendingCursorOperation implements PromiseLike<Document[]> {
     /**
      * Removes all documents that match the query generated by the preceding
      * function chaining.
      *
+     * @throws {Error} when called in a React Native environment.
      * @returns An array promise containing the IDs of the documents that were
      * removed.
      */
@@ -2124,6 +2223,7 @@ declare abstract class BasePendingCursorOperation implements PromiseLike<Documen
      * Evicts all documents that match the query generated by the preceding
      * function chaining.
      *
+     * @throws {Error} when called in a React Native environment.
      * @return An array promise containing the IDs of the documents that were
      * evicted.
      */
@@ -2139,6 +2239,7 @@ declare abstract class BasePendingCursorOperation implements PromiseLike<Documen
      * matching the query. The documents are instances of {@link MutableDocument}
      * so you can call update-related functions on them.
      *
+     * @throws {Error} when called in a React Native environment.
      * @returns An {@link UpdateResultsMap} promise mapping document IDs to lists
      * of {@link UpdateResult | update results} that describe the updates that
      * were performed for each document.
@@ -2162,6 +2263,7 @@ declare abstract class BasePendingCursorOperation implements PromiseLike<Documen
      * @param direction Specify whether you want the sorting order to be
      * `ascending` or `descending`. Defaults to `ascending`.
      *
+     * @throws {Error} when called in a React Native environment.
      * @return A cursor that you can chain further function calls and then either
      * get the matching documents immediately or get updates about them over time.
      */
@@ -2178,6 +2280,7 @@ declare abstract class BasePendingCursorOperation implements PromiseLike<Documen
      * @param offset The number of matching documents that you want the eventual
      * resulting set of matching documents to be offset by (and thus not include).
      *
+     * @throws {Error} when called in a React Native environment.
      * @return A cursor that you can chain further function calls and then either
      * get the matching documents immediately or get updates about them over time.
      */
@@ -2188,6 +2291,7 @@ declare abstract class BasePendingCursorOperation implements PromiseLike<Documen
      *
      * @param limit The maximum number of documents that will be returned.
      *
+     * @throws {Error} when called in a React Native environment.
      * @return A cursor that you can chain further function calls and then either
      * get the matching documents immediately or get updates about them over time.
      */
@@ -2196,6 +2300,7 @@ declare abstract class BasePendingCursorOperation implements PromiseLike<Documen
      * Executes the query generated by the preceding function chaining and return
      * the list of matching documents.
      *
+     * @throws {Error} when called in a React Native environment.
      * @returns An array promise containing {@link Document | documents} matching
      * the query generated by the preceding function chaining.
      */
@@ -2256,6 +2361,8 @@ interface LiveQueryEventUpdateParams {
 /**
  * First event fired immediately after registering a live query without any
  * mutations. All subsequent events are of type {@link LiveQueryEventUpdate}.
+ *
+ * Not available in React Native environments.
  */
 declare class LiveQueryEventInitial {
     /**
@@ -2280,6 +2387,8 @@ declare class LiveQueryEventInitial {
 /**
  * Represents an update event describing all changes that occured for documents
  * covered by a (live) query.
+ *
+ * Not available in React Native environments.
  */
 declare class LiveQueryEventUpdate {
     /**
@@ -2317,6 +2426,7 @@ declare class LiveQueryEventUpdate {
     /**
      * Returns a hash that represents the set of matching documents.
      *
+     * @throws {Error} when called in a React Native environment.
      * @deprecated use {@link Document.hash | Document.hash()} instead.
      */
     hash(documents: Document[]): BigInt;
@@ -2324,6 +2434,7 @@ declare class LiveQueryEventUpdate {
      * Returns a pattern of words that together create a mnemonic, which
      * represents the set of matching documents.
      *
+     * @throws {Error} when called in a React Native environment.
      * @deprecated use {@link Document.hashMnemonic | Document.hashMnemonic()} instead.
      */
     hashMnemonic(documents: Document[]): string;
@@ -2392,6 +2503,8 @@ type QueryObservationHandler = (documents: Document[], event: LiveQueryEvent, si
  * preceding `find`-like call.
  *
  * Update and remove functionality is also exposed through this object.
+ *
+ * Not available in React Native environments.
  */
 declare class PendingCursorOperation extends BasePendingCursorOperation {
     sort(propertyPath: string, direction?: SortDirection): PendingCursorOperation;
@@ -2411,6 +2524,8 @@ declare class PendingCursorOperation extends BasePendingCursorOperation {
      * The returned {@link Subscription} object must be kept in scope for as long
      * as you want to keep receiving updates.
      *
+     * @throws {Error} when called in a React Native environment.
+     *
      * @returns A {@link Subscription} object that must be kept in scope for as
      * long as you want to keep receiving updates for documents that match the
      * query specified in the preceding chain.
@@ -2437,6 +2552,8 @@ declare class PendingCursorOperation extends BasePendingCursorOperation {
      * transaction committed to the store that involves modifications to documents
      * matching the query in the collection this method was called on.
      *
+     * @throws {Error} when called in a React Native environment.
+     *
      * @return A {@link LiveQuery} object that must be kept in scope for as long
      * as you want to keep receiving updates.
      */
@@ -2464,6 +2581,8 @@ declare class PendingCursorOperation extends BasePendingCursorOperation {
      * documents matching the query in the collection that this method was called
      * on.
      *
+     * @throws {Error} when called in a React Native environment.
+     *
      * @return A {@link LiveQuery} object that must be kept in scope for as long
      * as you want to keep receiving updates.
      */
@@ -2498,6 +2617,8 @@ type SingleObservationHandler = (document: Document | null, event: SingleDocumen
  * {@link Collection.findByID | findByID()} call.
  *
  * Update and remove functionality is also exposed through this object.
+ *
+ * Not available in React Native environments.
  */
 declare class PendingIDSpecificOperation extends BasePendingIDSpecificOperation {
     remove(): Promise<boolean>;
@@ -2514,6 +2635,8 @@ declare class PendingIDSpecificOperation extends BasePendingIDSpecificOperation
      * The returned {@link Subscription} object must be kept in scope for as long
      * as you want to keep receiving updates.
      *
+     * @throws {Error} when called in a React Native environment.
+     *
      * @returns A {@link Subscription} object that must be kept in scope for as
      * long as you want to keep receiving updates for the document.
      */
@@ -2537,6 +2660,8 @@ declare class PendingIDSpecificOperation extends BasePendingIDSpecificOperation
      * document with the relevant ID in the collection that
      * {@link PendingIDSpecificOperation.observeLocal | observeLocal()} was called on.
      *
+     * @throws {Error} when called in a React Native environment.
+     *
      * @returns A {@link LiveQuery} object that must be kept in scope for as long
      * as you want to keep receiving updates.
      */
@@ -2561,6 +2686,8 @@ declare class PendingIDSpecificOperation extends BasePendingIDSpecificOperation
      * document with the relevant ID in the collection that
      * {@link PendingIDSpecificOperation.observeLocal | observeLocal()} was called on.
      *
+     * @throws {Error} when called in a React Native environment.
+     *
      * @returns A {@link LiveQuery} object that must be kept in scope for as long
      * as you want to keep receiving updates.
      */
@@ -2578,6 +2705,8 @@ declare class PendingIDSpecificOperation extends BasePendingIDSpecificOperation
  * querying a collection. You can get a collection by calling
  * {@link Store.collection | collection()} on a {@link Store} of a {@link Ditto}
  * object.
+ *
+ * Not available in React Native environments.
  */
 declare class Collection implements CollectionInterface {
     /** The name of the collection. */
@@ -2602,6 +2731,7 @@ declare class Collection implements CollectionInterface {
      * Find more information about the query string format in the documentation's
      * section on {@link https://docs.ditto.live/javascript/common/concepts/querying Querying}
      *
+     * @throws {Error} when called in a React Native environment.
      * @param query The query to run against the collection.
      * @param queryArgs The arguments to use to replace placeholders in the
      * provided query.
@@ -2620,6 +2750,7 @@ declare class Collection implements CollectionInterface {
      * remove or evict the document.
      *
      * @param id The ID of the document to find.
+     * @throws {Error} when called in a React Native environment.
      */
     findByID(id: DocumentID | DocumentIDValue): PendingIDSpecificOperation;
     upsert(value: DocumentValue, options?: UpsertOptions): Promise<DocumentID>;
@@ -2646,9 +2777,10 @@ declare class Collection implements CollectionInterface {
      *
      * @param pathOrData The path to the file that you want to create an
      * attachment with or the raw data.
-     *
      * @param metadata Metadata relating to the attachment.
      *
+     * @throws {Error} when called in a React Native environment.
+     *
      * @deprecated Use {@link Store.newAttachment | ditto.store.newAttachment() }
      * instead.
      */
@@ -2671,10 +2803,11 @@ declare class Collection implements CollectionInterface {
      *
      * @param token The {@link AttachmentToken} relevant to the attachment that
      * you wish to download and observe. Throws if token is invalid.
-     *
      * @param eventHandler An optional callback that will be called when there is
      * an update to the status of the attachment fetch attempt.
      *
+     * @throws {Error} when called in a React Native environment.
+     *
      * @return An `AttachmentFetcher` object, which must be kept alive for the
      * fetch request to proceed and for you to be notified about the attachment's
      * fetch status changes.
@@ -2785,6 +2918,8 @@ interface CollectionsEventParams {
  * the collections that were previously known about in the previous event, along
  * with information about what collections have been inserted, deleted, updated,
  * or moved since the last event.
+ *
+ * Not available in React Native environments.
  */
 declare class CollectionsEvent {
     /**
@@ -2851,6 +2986,8 @@ type CollectionsObservationHandler = (event: CollectionsEvent, signalNext?: () =
  * A subscription, established by calling {@link subscribe | subscribe()}, will
  * act as a signal to other peers that the device connects to that you would
  * like to receive updates from them about the collections that they know about.
+ *
+ * Not available in React Native environments.
  */
 declare class PendingCollectionsOperation implements PromiseLike<Collection[]> {
     /**
@@ -2862,6 +2999,8 @@ declare class PendingCollectionsOperation implements PromiseLike<Collection[]> {
      * @param direction Specify whether you want the sorting order to be
      * `Ascending` or `Descending`.
      *
+     * @throws {Error} when called in a React Native environment.
+     *
      * @return A {@link PendingCollectionsOperation} that you can chain further
      * function calls to.
      */
@@ -2877,6 +3016,8 @@ declare class PendingCollectionsOperation implements PromiseLike<Collection[]> {
      * @param offset The number of collections that you want the eventual
      * resulting set of collections to be offset by (and thus not include).
      *
+     * @throws {Error} when called in a React Native environment.
+     *
      * @return A {@link PendingCollectionsOperation} that you can chain further
      * function calls to.
      */
@@ -2886,6 +3027,8 @@ declare class PendingCollectionsOperation implements PromiseLike<Collection[]> {
      *
      * @param limit The maximum number of collections that will be returned.
      *
+     * @throws {Error} when called in a React Native environment.
+     *
      * @return A {@link PendingCollectionsOperation} that you can chain further
      * function calls to.
      */
@@ -2897,6 +3040,8 @@ declare class PendingCollectionsOperation implements PromiseLike<Collection[]> {
      * The returned {@link Subscription} object must be kept in scope for as long
      * as you want to keep receiving updates.
      *
+     * @throws {Error} when called in a React Native environment.
+     *
      * @return A {@link Subscription} object that must be kept in scope for as
      * long as you want to keep receiving updates from other devices about the
      * collections that they know about.
@@ -2917,6 +3062,8 @@ declare class PendingCollectionsOperation implements PromiseLike<Collection[]> {
      * @param handler A closure that will be called every time there is an update
      * about the list of known about collections.
      *
+     * @throws {Error} when called in a React Native environment.
+     *
      * @return A {@link LiveQuery} object that must be kept in scope for as long
      * as you want to keep receiving updates.
      */
@@ -2936,6 +3083,8 @@ declare class PendingCollectionsOperation implements PromiseLike<Collection[]> {
      * @param handler A closure that will be called every time there is an update
      * about the list of known about collections.
      *
+     * @throws {Error} when called in a React Native environment.
+     *
      * @return A {@link LiveQuery} object that must be kept in scope for as long
      * as you want to keep receiving updates.
      */
@@ -2944,6 +3093,8 @@ declare class PendingCollectionsOperation implements PromiseLike<Collection[]> {
      * Return the list of collections requested based on the preceding function
      * chaining.
      *
+     * @throws {Error} when called in a React Native environment.
+     *
      * @return A list of {@link Collection}s based on the preceding function
      * chaining.
      */
@@ -2972,6 +3123,8 @@ declare class PendingCollectionsOperation implements PromiseLike<Collection[]> {
  * or evicting any matching documents.
  *
  * Live queries and subscriptions are only available outside of transactions.
+ *
+ * Not available in React Native environments.
  */
 declare class WriteTransactionPendingCursorOperation extends BasePendingCursorOperation {
     sort(propertyPath: string, direction?: SortDirection): WriteTransactionPendingCursorOperation;
@@ -3002,6 +3155,8 @@ declare class WriteTransactionPendingIDSpecificOperation extends BasePendingIDSp
  *
  * Create a `WriteTransactionCollection` by starting a {@link WriteTransaction}
  * and using its `scoped` method.
+ *
+ * Not available in React Native environments.
  */
 declare class WriteTransactionCollection implements CollectionInterface {
     /** The name of the collection. */
@@ -3025,11 +3180,14 @@ declare class WriteTransactionCollection implements CollectionInterface {
      * @param query The query to run against the collection.
      * @param queryArgs These arguments replace placeholders in the provided
      * query.
+     * @throws {Error} when called in a React Native environment.
      */
     find(query: string, queryArgs?: QueryArguments | undefined): WriteTransactionPendingCursorOperation;
     /**
      * Convenience method, equivalent to calling {@link find | find()} and passing
      * the query `"true"`.
+     *
+     * @throws {Error} when called in a React Native environment.
      */
     findAll(): WriteTransactionPendingCursorOperation;
     /**
@@ -3039,6 +3197,7 @@ declare class WriteTransactionCollection implements CollectionInterface {
      * The returned object can be used to find and return the document. It can also be used to update, remove or evict the document.
      *
      * @param id The ID of the document to find.
+     * @throws {Error} when called in a React Native environment.
      */
     findByID(id: any): WriteTransactionPendingIDSpecificOperation;
     upsert(value: DocumentValue, options?: UpsertOptions): Promise<DocumentID>;
@@ -3068,6 +3227,8 @@ declare class WriteTransactionCollection implements CollectionInterface {
  *
  * Please note that an `upsert` operation always results in the result type
  * `inserted`, regardless of whether it resulted in an update or insert.
+ *
+ * Not available in React Native environments.
  */
 interface WriteTransactionResult {
     type: 'inserted' | 'removed' | 'evicted' | 'updated';
@@ -3088,6 +3249,8 @@ declare class WriteTransaction {
      * provided to this function. You can create many
      * {@link WriteTransactionCollection | collection} objects per
      * {@link WriteTransaction} object.
+     *
+     * @throws {Error} when called in a React Native environment.
      * */
     scoped(toCollectionNamed: string): WriteTransactionCollection;
     /** @internal */
@@ -3226,6 +3389,8 @@ declare class Store {
      * * it is not empty
      * * it does not contain the char '\0'
      * * it does not begin with "$TS_"
+     *
+     * @throws {Error} when called in a React Native environment.
      */
     collection(name: string): Collection;
     /**
@@ -3234,11 +3399,15 @@ declare class Store {
      *
      * @return A {@link PendingCollectionsOperation} object that you can use to
      * fetch or observe the collections in the store
+     *
+     * @throws {Error} when called in a React Native environment.
      */
     collections(): PendingCollectionsOperation;
     /**
      * Returns the names of all available collections in the store of the
      * related {@link Ditto} instance.
+     *
+     * @throws {Error} when called in a React Native environment.
      */
     collectionNames(): Promise<string[]>;
     /**
@@ -3273,6 +3442,7 @@ declare class Store {
      * Allows you to group multiple operations together that affect multiple documents, potentially across multiple collections.
      *
      * @param callback is given access to a {@link WriteTransaction | write transaction object} that can be used to perform operations on the store.
+     * @throws {Error} when called in a React Native environment.
      * @returns a list of `WriteTransactionResult`s. There is a result for each operation performed as part of the write transaction.
      */
     write(callback: (transaction: WriteTransaction) => Promise<void>): Promise<WriteTransactionResult[]>;
@@ -3677,7 +3847,7 @@ declare class Sync {
      */
     readonly ditto: Ditto;
     /**
-     * All currently active sync subscriptions.
+     * All currently active {@link SyncSubscription | sync subscriptions}.
      *
      * **Note:** Manage sync subscriptions using
      * {@link registerSubscription | registerSubscription()} to register a new
@@ -4004,7 +4174,7 @@ declare class Ditto {
      * disables this behavior, thus allowing the use of an interactive debugger
      * without triggering the deadlock detection.
      *
-     * This feature is not available in the browser.
+     * This feature is only available in Node.js environments.
      */
     static disableDeadlockDetection(): void;
     /**
@@ -4014,8 +4184,8 @@ declare class Ditto {
      * {@link Ditto.disableDeadlockDetection | Ditto.disableDeadlockDetection()}
      * for more information.
      *
-     * This method always returns `false` in the browser where deadlock detection
-     * is not available.
+     * When called outside of a Node.js environment, this method always returns
+     * `false` as deadlock detection is only available in Node.js.
      *
      * @returns `true` if deadlock detection is enabled
      */
@@ -4174,7 +4344,8 @@ declare class Ditto {
      * This improves performance of initial sync when this peer has never before
      * connected to a Ditto mesh for which sync with v3 peers is disabled.
      *
-     * @throws {Error} if called in a React Native environment.
+     * @throws {Error} when called in a React Native environment where sync with v3
+     * is always disabled.
      */
     disableSyncWithV3(): Promise<void>;
     /**
@@ -4484,7 +4655,7 @@ declare class Logger {
      * callbacks.
      *
      * @throws {TypeError} if `callback` is not a function or `undefined`.
-     * @throws {Error} if called in a React Native environment.
+     * @throws {Error} when called in a React Native environment.
      */
     static setCustomLogCallback(callback?: CustomLogCallback): Promise<void>;
     /**