@converse/skeletor 2.0.0 → 3.0.1

package/dist/skeletor.d.ts

@@ -1,5 +1,39 @@
 import localForage from 'localforage';
 
+/**
+ * @public
+ */
+export declare class BrowserStorage {
+    storeInitialized: Promise<void>;
+    store: LocalForageWithExtensions;
+    name: string;
+    static sessionStorageInitialized: Promise<void>;
+    static localForage: typeof localForage;
+    constructor(id: string, type: 'local' | 'session' | 'indexed' | 'in_memory' | LocalForageWithExtensions, batchedWrites?: boolean);
+    /**
+     * @param type - The storage type: 'local', 'session', 'indexed', or 'in_memory'
+     * @param batchedWrites - Whether to enable batched writes
+     */
+    initStore(type: 'local' | 'session' | 'indexed' | 'in_memory', batchedWrites: boolean): Promise<void>;
+    flush(): void;
+    clear(): Promise<void>;
+    sync(): {
+        (method: SyncOperation, model: Model, options: SyncOptions): Promise<void>;
+        __name__: string;
+    };
+    removeCollectionReference(model: Model, collection: Collection | undefined): Promise<any> | undefined;
+    addCollectionReference(model: Model, collection: Collection | undefined): Promise<any> | undefined;
+    getCollectionReferenceData(model: Model): Record<string, string[]>;
+    save(model: Model): Promise<any>;
+    create(model: Model, options: SyncOptions): Promise<any>;
+    update(model: Model): Promise<any>;
+    find(model: Model): Promise<any>;
+    findAll(): Promise<any[]>;
+    destroy(model: Model, collection: Collection | undefined): Promise<Model>;
+    getStorageSize(): Promise<number>;
+    getItemName(id: string | number): string;
+}
+
 /**
  * @public
  */
@@ -16,7 +50,7 @@ export declare type ClassConstructor<T = any> = new (...args: any[]) => T;
  */
 export declare class Collection<T extends Model = Model> extends EventEmitterObject {
     [key: symbol]: () => CollectionIterator<T>;
-    _browserStorage?: Storage_2;
+    _browserStorage?: BrowserStorage;
     _comparator?: Comparator<T>;
     _url: string;
     models: T[];
@@ -30,8 +64,8 @@ export declare class Collection<T extends Model = Model> extends EventEmitterObj
     constructor(models?: T[] | ModelAttributes[] | T | ModelAttributes, options?: CollectionOptions<T>);
     get comparator(): Comparator<T>;
     set comparator(c: Comparator<T>);
-    set browserStorage(storage: Storage_2);
-    get browserStorage(): Storage_2 | undefined;
+    set browserStorage(storage: BrowserStorage);
+    get browserStorage(): BrowserStorage | undefined;
     /**
      * The default model for a collection is just a **Model**.
      * This should be overridden in most cases.
@@ -172,7 +206,7 @@ export declare class Collection<T extends Model = Model> extends EventEmitterObj
      * collection immediately, unless `wait: true` is passed, in which case we
      * wait for the server to agree.
      */
-    create(model: T | ModelAttributes, options?: Options): Promise<T> | T | false;
+    create(model: T | ModelAttributes, options?: FetchOrCreateOptions): Promise<T> | T;
     /**
      * **parse** converts a response into a list of models to be added to the
      * collection. The default implementation is just to pass it through.
@@ -408,6 +442,11 @@ export declare interface EventHandlersMap {
  */
 export declare type EventListenerMap = Record<string, ListeningType>;
 
+export declare type FetchOrCreateOptions = Options & {
+    promise?: boolean;
+    success?: (m: Model, resp: any, callbackOpts: Options) => void;
+};
+
 /**
  * @public
  */
@@ -472,7 +511,7 @@ export declare interface LocalForageWithExtensions {
  * performing computations and transformations on that data.
  */
 export declare class Model<T extends ModelAttributes = ModelAttributes> extends EventEmitterObject {
-    _browserStorage?: Storage_2;
+    _browserStorage?: BrowserStorage;
     _changing: boolean;
     _pending: boolean | ModelOptions;
     _previousAttributes?: T;
@@ -489,8 +528,8 @@ export declare class Model<T extends ModelAttributes = ModelAttributes> extends
      * is automatically generated and assigned for you.
      */
     constructor(attributes?: Partial<T>, options?: ModelOptions);
-    set browserStorage(storage: Storage_2);
-    get browserStorage(): Storage_2 | undefined;
+    set browserStorage(storage: BrowserStorage);
+    get browserStorage(): BrowserStorage | undefined;
     /**
      * The default name for the JSON `id` attribute is `"id"`. MongoDB and
      * CouchDB users may want to set this to `"_id"` (by overriding this getter
@@ -691,41 +730,6 @@ export declare interface SkeletorType {
     noConflict?: () => SkeletorType;
 }
 
-/**
- * @public
- */
-declare class Storage_2 {
-    storeInitialized: Promise<void>;
-    store: LocalForageWithExtensions;
-    name: string;
-    static sessionStorageInitialized: Promise<void>;
-    static localForage: typeof localForage;
-    constructor(id: string, type: 'local' | 'session' | 'indexed' | 'in_memory' | LocalForageWithExtensions, batchedWrites?: boolean);
-    /**
-     * @param type - The storage type: 'local', 'session', 'indexed', or 'in_memory'
-     * @param batchedWrites - Whether to enable batched writes
-     */
-    initStore(type: 'local' | 'session' | 'indexed' | 'in_memory', batchedWrites: boolean): Promise<void>;
-    flush(): void;
-    clear(): Promise<void>;
-    sync(): {
-        (method: SyncOperation, model: Model, options: SyncOptions): Promise<void>;
-        __name__: string;
-    };
-    removeCollectionReference(model: Model, collection: Collection | undefined): Promise<any> | undefined;
-    addCollectionReference(model: Model, collection: Collection | undefined): Promise<any> | undefined;
-    getCollectionReferenceData(model: Model): Record<string, string[]>;
-    save(model: Model): Promise<any>;
-    create(model: Model, options: SyncOptions): Promise<any>;
-    update(model: Model): Promise<any>;
-    find(model: Model): Promise<any>;
-    findAll(): Promise<any[]>;
-    destroy(model: Model, collection: Collection | undefined): Promise<Model>;
-    getStorageSize(): Promise<number>;
-    getItemName(id: string | number): string;
-}
-export { Storage_2 as Storage }
-
 /**
  * Override this function to change the manner in which Backbone persists
  * models to the server. You will be passed the type of request, and the