@dittolive/ditto 2.0.2 → 2.0.3

package/types/ditto.d.ts

@@ -478,19 +478,26 @@ declare class DocumentID {
     /**
      * Returns a string representation of the receiver.
      *
+     * If you need a string representation to be used directly in a query,
+     * please use `toQueryCompatibleString()` instead.
+     */
+    toString(): string;
+    /**
+     * Returns a byte representation of the document ID value as base64 string.
+     */
+    toBase64String(): string;
+    /**
+     * Returns a query compatible string representation of the receiver.
+     *
      * The returned string can be used directly in queries that you use with
      * other Ditto functions. For example you could create a query that was like
      * this:
      *
      *  ``` TypeScript
-     *  collection.find(`_id == ${documentID.toString()}`)
+     *  collection.find(`_id == ${documentID.toQueryCompatibleString()}`)
      *  ```
      */
-    toString(): string;
-    /**
-     * Returns a byte representation of the document ID value as base64 string.
-     */
-    toBase64String(): string;
+    toQueryCompatibleString(): string;
     /** @internal */
     toCBOR(): Uint8Array;
 }
@@ -1113,19 +1120,11 @@ declare class AttachmentFetcher implements PromiseLike<Attachment | null> {
     readonly eventHandler: (attachmentFetchEvent: AttachmentFetchEvent) => void | null;
     /** @internal */
     constructor(ditto: Ditto, token: AttachmentToken, eventHandler?: (attachmentFetchEvent: AttachmentFetchEvent) => void);
-    private cancelToken;
+    private cancelTokenPromise;
+    private static finalizationRegistry;
+    private static stopWithContextInfo;
 }
 
-/** @internal */
-declare type SubscriptionContextInfo = {
-    ditto: Ditto;
-    collectionName: string;
-    query: string;
-    queryArgsCBOR: Uint8Array | null;
-    orderBys: OrderBy[];
-    limit: number;
-    offset: number;
-};
 /**
  * Used to subscribe to receive updates from remote peers about matching
  * documents.
@@ -1867,10 +1866,10 @@ declare class Collection {
      * will not automatically be downloaded along with the document. You trigger
      * an attachment to be downloaded locally to a device by calling this method.
      * It will report events relating to the attachment fetch attempt as it tries
-     * to download it. The `onFetchEvent` block may be called multiple times with
+     * to download it. The `eventHandler` block may be called multiple times with
      * progress events. It will then be called with either a  `Completed` event or
      * a `Deleted` event. If downloading the attachment succeeds then the
-     * `Completed` event that the `callback` will be called with will hold a
+     * `Completed` event that the `eventHandler` will be called with will hold a
      * reference to the downloaded attachment.
      *
      * @param token The {@link AttachmentToken} relevant to the attachment that
@@ -1878,6 +1877,10 @@ declare class Collection {
      *
      * @param eventHandler An optional callback that will be called when there is
      * an update to the status of the attachment fetch attempt.
+     *
+     * @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.
      */
     fetchAttachment(token: AttachmentToken, eventHandler?: (AttachmentFetchEvent: any) => void): AttachmentFetcher;
     /** @internal */
@@ -2620,5 +2623,5 @@ declare class CBOR {
     static decode(data: Uint8Array): any;
 }
 
-export { Attachment, AttachmentFetchEvent, AttachmentFetchEventCompleted, AttachmentFetchEventDeleted, AttachmentFetchEventProgress, AttachmentFetchEventType, AttachmentFetcher, AttachmentToken, AuthenticationHandler, AuthenticationStatus, Authenticator, CBOR, Collection, CollectionsEvent, CollectionsEventParams, CollectionsObservationHandler, ConditionSource, Counter, CustomLogCallback, Ditto, Document, DocumentID, DocumentIDValue, DocumentPath, DocumentValue, Identity, IdentityManual, IdentityOfflinePlayground, IdentityOnlinePlayground, IdentityOnlineWithAuthentication, IdentitySharedKey, IdentityTypesRequiringOfflineLicenseToken, InitOptions, KeepAlive, LiveQuery, LiveQueryEvent, LiveQueryEventInitial, LiveQueryEventUpdate, LiveQueryEventUpdateParams, LiveQueryMove, LogLevel, Logger, MutableCounter, MutableDocument, MutableDocumentPath, MutableRGA, MutableRegister, NotAvailableAuthenticator, Observer, ObserverOptions, OnlineAuthenticator, PendingCollectionsOperation, PendingCursorOperation, PendingIDSpecificOperation, PresenceConnectionType, QueryArguments, QueryObservationHandler, RGA, Register, RemotePeer, SingleDocumentLiveQueryEvent, SingleObservationHandler, SortDirection, Store, Subscription, SubscriptionContextInfo, TransportCondition, TransportConfig, TransportConfigConnect, TransportConfigGlobal, TransportConfigLan, TransportConfigListen, TransportConfigListenHTTP, TransportConfigListenTCP, TransportConfigPeerToPeer, UpdateResult, UpdateResultType, UpdateResultsMap, UpsertOptions, Value, WebAssemblyModule, WriteStrategy, attachmentBridge, dittoBridge, documentBridge, init, mutableDocumentBridge, validateDocumentIDCBOR, validateDocumentIDValue };
+export { Attachment, AttachmentFetchEvent, AttachmentFetchEventCompleted, AttachmentFetchEventDeleted, AttachmentFetchEventProgress, AttachmentFetchEventType, AttachmentFetcher, AttachmentToken, AuthenticationHandler, AuthenticationStatus, Authenticator, CBOR, Collection, CollectionsEvent, CollectionsEventParams, CollectionsObservationHandler, ConditionSource, Counter, CustomLogCallback, Ditto, Document, DocumentID, DocumentIDValue, DocumentPath, DocumentValue, Identity, IdentityManual, IdentityOfflinePlayground, IdentityOnlinePlayground, IdentityOnlineWithAuthentication, IdentitySharedKey, IdentityTypesRequiringOfflineLicenseToken, InitOptions, KeepAlive, LiveQuery, LiveQueryEvent, LiveQueryEventInitial, LiveQueryEventUpdate, LiveQueryEventUpdateParams, LiveQueryMove, LogLevel, Logger, MutableCounter, MutableDocument, MutableDocumentPath, MutableRGA, MutableRegister, NotAvailableAuthenticator, Observer, ObserverOptions, OnlineAuthenticator, PendingCollectionsOperation, PendingCursorOperation, PendingIDSpecificOperation, PresenceConnectionType, QueryArguments, QueryObservationHandler, RGA, Register, RemotePeer, SingleDocumentLiveQueryEvent, SingleObservationHandler, SortDirection, Store, Subscription, TransportCondition, TransportConfig, TransportConfigConnect, TransportConfigGlobal, TransportConfigLan, TransportConfigListen, TransportConfigListenHTTP, TransportConfigListenTCP, TransportConfigPeerToPeer, UpdateResult, UpdateResultType, UpdateResultsMap, UpsertOptions, Value, WebAssemblyModule, WriteStrategy, attachmentBridge, dittoBridge, documentBridge, init, mutableDocumentBridge, validateDocumentIDCBOR, validateDocumentIDValue };
 //# sourceMappingURL=ditto.d.ts.map