@ember-data/store 5.4.0-alpha.32 → 5.4.0-alpha.33

package/unstable-preview-types/-private/record-arrays/identifier-array.d.ts

@@ -1,135 +1,137 @@
-import type { Signal } from '@ember-data/tracking/-private';
-import type { StableRecordIdentifier } from '@warp-drive/core-types/identifier';
-import type { TypedRecordInstance, TypeFromInstance } from '@warp-drive/core-types/record';
-import type { ImmutableRequestInfo } from '@warp-drive/core-types/request';
-import type { Links, PaginationLinks } from '@warp-drive/core-types/spec/raw';
-import type RecordArrayManager from '../managers/record-array-manager';
-import type Store from '../store-service';
-export declare const ARRAY_SIGNAL: unique symbol;
-export declare const SOURCE: unique symbol;
-export declare const MUTATE: unique symbol;
-export declare const NOTIFY: unique symbol;
-declare const IS_COLLECTION: unique symbol;
-export declare function notifyArray(arr: IdentifierArray): void;
-declare global {
-    interface ProxyConstructor {
-        new <TSource extends object, TTarget extends object>(target: TSource, handler: ProxyHandler<TSource>): TTarget;
-    }
-}
-export type IdentifierArrayCreateOptions<T = unknown> = {
-    identifiers: StableRecordIdentifier[];
-    type?: T extends TypedRecordInstance ? TypeFromInstance<T> : string;
-    store: Store;
-    allowMutation: boolean;
-    manager: RecordArrayManager;
-    links?: Links | PaginationLinks | null;
-    meta?: Record<string, unknown> | null;
-};
-/**
-  A record array is an array that contains records of a certain type (or modelName).
-  The record array materializes records as needed when they are retrieved for the first
-  time. You should not create record arrays yourself. Instead, an instance of
-  `RecordArray` or its subclasses will be returned by your application's store
-  in response to queries.
-
-  This class should not be imported and instantiated by consuming applications.
-
-  @class RecordArray
-  @public
-*/
-interface IdentifierArray<T = unknown> extends Omit<Array<T>, '[]'> {
-    [MUTATE]?(target: StableRecordIdentifier[], receiver: typeof Proxy<StableRecordIdentifier[], T[]>, prop: string, args: unknown[], _SIGNAL: Signal): unknown;
-}
-declare class IdentifierArray<T = unknown> {
-    DEPRECATED_CLASS_NAME: string;
-    /**
-      The flag to signal a `RecordArray` is currently loading data.
-      Example
-      ```javascript
-      let people = store.peekAll('person');
-      people.isUpdating; // false
-      people.update();
-      people.isUpdating; // true
-      ```
-      @property isUpdating
-      @public
-      @type Boolean
-    */
-    isUpdating: boolean;
-    isLoaded: boolean;
-    isDestroying: boolean;
-    isDestroyed: boolean;
-    _updatingPromise: Promise<IdentifierArray<T>> | null;
-    [IS_COLLECTION]: boolean;
-    [ARRAY_SIGNAL]: Signal;
-    [SOURCE]: StableRecordIdentifier[];
-    [NOTIFY](): void;
-    links: Links | PaginationLinks | null;
-    meta: Record<string, unknown> | null;
-    modelName?: T extends TypedRecordInstance ? TypeFromInstance<T> : string;
-    /**
-      The store that created this record array.
+declare module '@ember-data/store/-private/record-arrays/identifier-array' {
+  import type { Signal } from '@ember-data/tracking/-private';
+  import type { StableRecordIdentifier } from '@warp-drive/core-types/identifier';
+  import type { TypedRecordInstance, TypeFromInstance } from '@warp-drive/core-types/record';
+  import type { ImmutableRequestInfo } from '@warp-drive/core-types/request';
+  import type { Links, PaginationLinks } from '@warp-drive/core-types/spec/raw';
+  import type RecordArrayManager from '@ember-data/store/-private/managers/record-array-manager';
+  import type Store from '@ember-data/store/-private/store-service';
+  export declare const ARRAY_SIGNAL: unique symbol;
+  export declare const SOURCE: unique symbol;
+  export declare const MUTATE: unique symbol;
+  export declare const NOTIFY: unique symbol;
+  declare const IS_COLLECTION: unique symbol;
+  export declare function notifyArray(arr: IdentifierArray): void;
+  declare global {
+      interface ProxyConstructor {
+          new <TSource extends object, TTarget extends object>(target: TSource, handler: ProxyHandler<TSource>): TTarget;
+      }
+  }
+  export type IdentifierArrayCreateOptions<T = unknown> = {
+      identifiers: StableRecordIdentifier[];
+      type?: T extends TypedRecordInstance ? TypeFromInstance<T> : string;
+      store: Store;
+      allowMutation: boolean;
+      manager: RecordArrayManager;
+      links?: Links | PaginationLinks | null;
+      meta?: Record<string, unknown> | null;
+  };
+  /**
+    A record array is an array that contains records of a certain type (or modelName).
+    The record array materializes records as needed when they are retrieved for the first
+    time. You should not create record arrays yourself. Instead, an instance of
+    `RecordArray` or its subclasses will be returned by your application's store
+    in response to queries.
   
-      @property store
-      @private
-      @type Store
-      */
-    store: Store;
-    _manager: RecordArrayManager;
-    destroy(clear: boolean): void;
-    get length(): number;
-    set length(value: number);
-    constructor(options: IdentifierArrayCreateOptions<T>);
-    /**
-      Used to get the latest version of all of the records in this array
-      from the adapter.
-  
-      Example
-  
-      ```javascript
-      let people = store.peekAll('person');
-      people.isUpdating; // false
+    This class should not be imported and instantiated by consuming applications.
   
-      people.update().then(function() {
+    @class RecordArray
+    @public
+  */
+  interface IdentifierArray<T = unknown> extends Omit<Array<T>, '[]'> {
+      [MUTATE]?(target: StableRecordIdentifier[], receiver: typeof Proxy<StableRecordIdentifier[], T[]>, prop: string, args: unknown[], _SIGNAL: Signal): unknown;
+  }
+  declare class IdentifierArray<T = unknown> {
+      DEPRECATED_CLASS_NAME: string;
+      /**
+        The flag to signal a `RecordArray` is currently loading data.
+        Example
+        ```javascript
+        let people = store.peekAll('person');
         people.isUpdating; // false
-      });
-  
-      people.isUpdating; // true
-      ```
-  
-      @method update
-      @public
-    */
-    update(): Promise<IdentifierArray<T>>;
-    _update(): Promise<IdentifierArray<T>>;
-    /**
-      Saves all of the records in the `RecordArray`.
-  
-      Example
-  
-      ```javascript
-      let messages = store.peekAll('message');
-      messages.forEach(function(message) {
-        message.hasBeenSeen = true;
-      });
-      messages.save();
-      ```
-  
-      @method save
-      @public
-      @return {Promise<IdentifierArray>} promise
-    */
-    save(): Promise<IdentifierArray>;
-}
-export default IdentifierArray;
-export type CollectionCreateOptions = IdentifierArrayCreateOptions & {
-    query: ImmutableRequestInfo | Record<string, unknown> | null;
-    isLoaded: boolean;
-};
-export declare class Collection<T = unknown> extends IdentifierArray<T> {
-    query: ImmutableRequestInfo | Record<string, unknown> | null;
-    constructor(options: CollectionCreateOptions);
-    _update(): Promise<Collection<T>>;
-    destroy(clear: boolean): void;
-}
-//# sourceMappingURL=identifier-array.d.ts.map
+        people.update();
+        people.isUpdating; // true
+        ```
+        @property isUpdating
+        @public
+        @type Boolean
+      */
+      isUpdating: boolean;
+      isLoaded: boolean;
+      isDestroying: boolean;
+      isDestroyed: boolean;
+      _updatingPromise: Promise<IdentifierArray<T>> | null;
+      [IS_COLLECTION]: boolean;
+      [ARRAY_SIGNAL]: Signal;
+      [SOURCE]: StableRecordIdentifier[];
+      [NOTIFY](): void;
+      links: Links | PaginationLinks | null;
+      meta: Record<string, unknown> | null;
+      modelName?: T extends TypedRecordInstance ? TypeFromInstance<T> : string;
+      /**
+        The store that created this record array.
+    
+        @property store
+        @private
+        @type Store
+        */
+      store: Store;
+      _manager: RecordArrayManager;
+      destroy(clear: boolean): void;
+      get length(): number;
+      set length(value: number);
+      constructor(options: IdentifierArrayCreateOptions<T>);
+      /**
+        Used to get the latest version of all of the records in this array
+        from the adapter.
+    
+        Example
+    
+        ```javascript
+        let people = store.peekAll('person');
+        people.isUpdating; // false
+    
+        people.update().then(function() {
+          people.isUpdating; // false
+        });
+    
+        people.isUpdating; // true
+        ```
+    
+        @method update
+        @public
+      */
+      update(): Promise<IdentifierArray<T>>;
+      _update(): Promise<IdentifierArray<T>>;
+      /**
+        Saves all of the records in the `RecordArray`.
+    
+        Example
+    
+        ```javascript
+        let messages = store.peekAll('message');
+        messages.forEach(function(message) {
+          message.hasBeenSeen = true;
+        });
+        messages.save();
+        ```
+    
+        @method save
+        @public
+        @return {Promise<IdentifierArray>} promise
+      */
+      save(): Promise<IdentifierArray>;
+  }
+  export default IdentifierArray;
+  export type CollectionCreateOptions = IdentifierArrayCreateOptions & {
+      query: ImmutableRequestInfo | Record<string, unknown> | null;
+      isLoaded: boolean;
+  };
+  export declare class Collection<T = unknown> extends IdentifierArray<T> {
+      query: ImmutableRequestInfo | Record<string, unknown> | null;
+      constructor(options: CollectionCreateOptions);
+      _update(): Promise<Collection<T>>;
+      destroy(clear: boolean): void;
+  }
+  //# sourceMappingURL=identifier-array.d.ts.map
+}