Documentation / @ember-data/model / index / ManyArray

Defined in: packages/store/unstable-preview-types/-private/record-arrays/many-array.d.ts:70

A ManyArray is a MutableArray that represents the contents of a has-many relationship.

The ManyArray is instantiated lazily the first time the relationship is requested.

This class is not intended to be directly instantiated by consuming applications.

Inverses

Often, the relationships in Ember Data applications will have an inverse. For example, imagine the following models are defined:

app/models/post.js

import Model, { hasMany } from '@ember-data/model';

export default class PostModel extends Model {
  @hasMany('comment') comments;
}

app/models/comment.js

import Model, { belongsTo } from '@ember-data/model';

export default class CommentModel extends Model {
  @belongsTo('post') post;
}

If you created a new instance of Post and added a Comment record to its comments has-many relationship, you would expect the comment's post property to be set to the post that contained the has-many.

We call the record to which a relationship belongs-to the relationship's owner.

ManyArray

Extends

• IdentifierArray<T>

Type Parameters

T

T = unknown

Indexable

[key: number]: T

Constructors

Constructor

new ManyArray<T>(options): RelatedCollection<T>;

Defined in: packages/store/unstable-preview-types/-private/record-arrays/many-array.d.ts:143

Parameters

options

ManyArrayCreateArgs<T>

Returns

RelatedCollection<T>

Overrides

IdentifierArray<T>.constructor

Properties

___(unique) Symbol(#[])

___(unique) Symbol(#[]): WarpDriveSignal;

Defined in: packages/store/unstable-preview-types/-private/record-arrays/identifier-array.d.ts:73

Inherited from

IdentifierArray.___(unique) Symbol(#[])

---

___(unique) Symbol(#source)

___(unique) Symbol(#source): StableRecordIdentifier[];

Defined in: packages/store/unstable-preview-types/-private/record-arrays/identifier-array.d.ts:74

Inherited from

IdentifierArray.___(unique) Symbol(#source)

---

___(unique) Symbol(IS_COLLECTION)

___(unique) Symbol(IS_COLLECTION): boolean;

Defined in: packages/store/unstable-preview-types/-private/record-arrays/identifier-array.d.ts:72

Inherited from

IdentifierArray.___(unique) Symbol(IS_COLLECTION)

---

_inverseIsAsync

_inverseIsAsync: boolean;

Defined in: packages/store/unstable-preview-types/-private/record-arrays/many-array.d.ts:88

---

_manager

_manager: MinimumManager;

Defined in: packages/store/unstable-preview-types/-private/record-arrays/many-array.d.ts:138

Overrides

IdentifierArray._manager

---

_updatingPromise

_updatingPromise: null | Promise<IdentifierArray<T>>;

Defined in: packages/store/unstable-preview-types/-private/record-arrays/identifier-array.d.ts:70

Inherited from

IdentifierArray._updatingPromise

---

[unscopables]

readonly [unscopables]: object;

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:97

Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Index Signature

[key: number]: undefined | boolean

[iterator]?

optional [iterator]: boolean;

[unscopables]?

readonly optional [unscopables]: boolean;

Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

at?

optional at: boolean;

concat?

optional concat: boolean;

copyWithin?

optional copyWithin: boolean;

entries?

optional entries: boolean;

every?

optional every: boolean;

fill?

optional fill: boolean;

filter?

optional filter: boolean;

find?

optional find: boolean;

findIndex?

optional findIndex: boolean;

findLast?

optional findLast: boolean;

findLastIndex?

optional findLastIndex: boolean;

flat?

optional flat: boolean;

flatMap?

optional flatMap: boolean;

forEach?

optional forEach: boolean;

includes?

optional includes: boolean;

indexOf?

optional indexOf: boolean;

join?

optional join: boolean;

keys?

optional keys: boolean;

lastIndexOf?

optional lastIndexOf: boolean;

length?

optional length: boolean;

Gets or sets the length of the array. This is a number one higher than the highest index in the array.

map?

optional map: boolean;

pop?

optional pop: boolean;

push?

optional push: boolean;

reduce?

optional reduce: boolean;

reduceRight?

optional reduceRight: boolean;

reverse?

optional reverse: boolean;

shift?

optional shift: boolean;

slice?

optional slice: boolean;

some?

optional some: boolean;

sort?

optional sort: boolean;

splice?

optional splice: boolean;

toLocaleString?

optional toLocaleString: boolean;

toReversed?

optional toReversed: boolean;

toSorted?

optional toSorted: boolean;

toSpliced?

optional toSpliced: boolean;

toString?

optional toString: boolean;

unshift?

optional unshift: boolean;

values?

optional values: boolean;

with?

optional with: boolean;

Inherited from

IdentifierArray.[unscopables]

---

cache

cache: Cache;

Defined in: packages/store/unstable-preview-types/-private/record-arrays/many-array.d.ts:137

---

DEPRECATED_CLASS_NAME

DEPRECATED_CLASS_NAME: string;

Defined in: packages/store/unstable-preview-types/-private/record-arrays/identifier-array.d.ts:52

Inherited from

IdentifierArray.DEPRECATED_CLASS_NAME

---

identifier

identifier: StableRecordIdentifier;

Defined in: packages/store/unstable-preview-types/-private/record-arrays/many-array.d.ts:136

Overrides

IdentifierArray.identifier

---

isAsync

isAsync: boolean;

Defined in: packages/store/unstable-preview-types/-private/record-arrays/many-array.d.ts:71

---

isDestroyed

isDestroyed: boolean;

Defined in: packages/store/unstable-preview-types/-private/record-arrays/identifier-array.d.ts:69

Inherited from

IdentifierArray.isDestroyed

---

isDestroying

isDestroying: boolean;

Defined in: packages/store/unstable-preview-types/-private/record-arrays/identifier-array.d.ts:68

Inherited from

IdentifierArray.isDestroying

---

isLoaded

isLoaded: boolean;

Defined in: packages/store/unstable-preview-types/-private/record-arrays/many-array.d.ts:79

The loading state of this array

Overrides

IdentifierArray.isLoaded

---

isUpdating

isUpdating: boolean;

Defined in: packages/store/unstable-preview-types/-private/record-arrays/identifier-array.d.ts:66

The flag to signal a RecordArray is currently loading data. Example

let people = store.peekAll('person');
people.isUpdating; // false
people.update();
people.isUpdating; // true

Inherited from

IdentifierArray.isUpdating

---

key

key: string;

Defined in: packages/store/unstable-preview-types/-private/record-arrays/many-array.d.ts:140

---

length

length: number;

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts:1326

Gets or sets the length of the array. This is a number one higher than the highest index in the array.

Inherited from

IdentifierArray.length

---

links

links: 
  | null
  | Links
  | PaginationLinks;

Defined in: packages/store/unstable-preview-types/-private/record-arrays/many-array.d.ts:135

Retrieve the links for this relationship

Overrides

IdentifierArray.links

---

meta

meta: null | Record<string, unknown>;

Defined in: packages/store/unstable-preview-types/-private/record-arrays/many-array.d.ts:127

Metadata associated with the request for async hasMany relationships.

Example

Given that the server returns the following JSON payload when fetching a hasMany relationship:

{
  "comments": [{
    "id": 1,
    "comment": "This is the first comment",
  }, {
// ...
  }],

  "meta": {
    "page": 1,
    "total": 5
  }
}

You can then access the meta data via the meta property:

let comments = await post.comments;
let meta = comments.meta;

// meta.page => 1
// meta.total => 5

Overrides

IdentifierArray.meta

---

modelName

modelName: T extends TypedRecordInstance ? TypeFromInstance<T<T>> : string;

Defined in: packages/store/unstable-preview-types/-private/record-arrays/many-array.d.ts:142

Overrides

IdentifierArray.modelName

---

save()

save: () => Promise<IdentifierArray<T>>;

Defined in: packages/store/unstable-preview-types/-private/record-arrays/many-array.d.ts:196

Saves all of the records in the ManyArray.

Note: this API can only be used in legacy mode with a configured Adapter.

Example

const { content: { data: inbox } } = await store.request(findRecord({ type: 'inbox', id: '1' }));

let messages = await inbox.messages;
messages.forEach((message) => {
  message.isRead = true;
});
messages.save();

Returns

Promise<IdentifierArray<T>>

promise

Overrides

IdentifierArray.save

---

type

type: ModelSchema;

Defined in: packages/store/unstable-preview-types/-private/record-arrays/many-array.d.ts:141

Methods

___(unique) Symbol(#update)()

___(unique) Symbol(#update)(
   target, 
   receiver, 
   prop, 
   args, 
   _SIGNAL): unknown;

Defined in: packages/store/unstable-preview-types/-private/record-arrays/many-array.d.ts:144

Parameters

target

StableRecordIdentifier[]

receiver

typeof NativeProxy

prop

string

args

unknown[]

_SIGNAL

WarpDriveSignal

Returns

unknown

Overrides

IdentifierArray.___(unique) Symbol(#update)

---

_update()

_update(): Promise<IdentifierArray<T>>;

Defined in: packages/store/unstable-preview-types/-private/record-arrays/identifier-array.d.ts:109

Returns

Promise<IdentifierArray<T>>

Inherited from

IdentifierArray._update

---

[iterator]()

iterator: ArrayIterator<T>;

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:78

Iterator

Returns

ArrayIterator<T>

Inherited from

IdentifierArray.[iterator]

---

at()

at(index): undefined | T;

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es2022.array.d.ts:24

Returns the item located at the specified index.

Parameters

index

number

The zero-based index of the desired code unit. A negative index will count back from the last item.

Returns

undefined | T

Inherited from

IdentifierArray.at

---

concat()

Call Signature

concat(...items): T[];

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts:1350

Combines two or more arrays. This method returns a new array without modifying any existing arrays.

Parameters

items

...ConcatArray<T>[]

Additional arrays and/or items to add to the end of the array.

Returns

T[]

Inherited from

IdentifierArray.concat

Call Signature

concat(...items): T[];

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts:1356

Combines two or more arrays. This method returns a new array without modifying any existing arrays.

Parameters

items

...(T | ConcatArray<T>)[]

Additional arrays and/or items to add to the end of the array.

Returns

T[]

Inherited from

IdentifierArray.concat

---

copyWithin()

copyWithin(
   target, 
   start, 
   end?): this;

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es2015.core.d.ts:62

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters

target

number

If target is negative, it is treated as length+target where length is the length of the array.

start

number

If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

end?

number

If not specified, length of the this object is used as its default value.

Returns

this

Inherited from

IdentifierArray.copyWithin

---

createRecord()

createRecord(hash): T;

Defined in: packages/store/unstable-preview-types/-private/record-arrays/many-array.d.ts:175

Create a child record within the owner

Parameters

hash

CreateRecordProperties<T>

Returns

T

record

---

entries()

entries(): ArrayIterator<[number, T]>;

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:83

Returns an iterable of key, value pairs for every entry in the array

Returns

ArrayIterator<[number, T]>

Inherited from

IdentifierArray.entries

---

every()

Call Signature

every<S>(predicate, thisArg?): this is S[];

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts:1433

Determines whether all the members of an array satisfy the specified test.

Type Parameters

S

S

Parameters

predicate

(value, index, array) => value is S

A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

thisArg?

any

An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Returns

this is S[]

Inherited from

IdentifierArray.every

Call Signature

every(predicate, thisArg?): boolean;

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts:1442

Determines whether all the members of an array satisfy the specified test.

Parameters

predicate

(value, index, array) => unknown

A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

thisArg?

any

An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Returns

boolean

Inherited from

IdentifierArray.every

---

fill()

fill(
   value, 
   start?, 
   end?): this;

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es2015.core.d.ts:51

Changes all array elements from start to end index to a static value and returns the modified array

Parameters

value

T

value to fill array section with

start?

number

index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

end?

number

index to stop filling the array at. If end is negative, it is treated as length+end.

Returns

this

Inherited from

IdentifierArray.fill

---

filter()

Call Signature

filter<S>(predicate, thisArg?): S[];

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts:1469

Returns the elements of an array that meet the condition specified in a callback function.

Type Parameters

S

S

Parameters

predicate

(value, index, array) => value is S

A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.

thisArg?

any

An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Returns

S[]

Inherited from

IdentifierArray.filter

Call Signature

filter(predicate, thisArg?): T[];

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts:1475

Returns the elements of an array that meet the condition specified in a callback function.

Parameters

predicate

(value, index, array) => unknown

A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.

thisArg?

any

An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Returns

T[]

Inherited from

IdentifierArray.filter

---

find()

Call Signature

find<S>(predicate, thisArg?): undefined | S;

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es2015.core.d.ts:29

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type Parameters

S

S

Parameters

predicate

(value, index, obj) => value is S

find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

thisArg?

any

If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns

undefined | S

Inherited from

IdentifierArray.find

Call Signature

find(predicate, thisArg?): undefined | T;

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es2015.core.d.ts:30

Parameters

predicate

(value, index, obj) => unknown

thisArg?

any

Returns

undefined | T

Inherited from

IdentifierArray.find

---

findIndex()

findIndex(predicate, thisArg?): number;

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es2015.core.d.ts:41

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters

predicate

(value, index, obj) => unknown

find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

thisArg?

any

If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns

number

Inherited from

IdentifierArray.findIndex

---

findLast()

Call Signature

findLast<S>(predicate, thisArg?): undefined | S;

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es2023.array.d.ts:29

Returns the value of the last element in the array where predicate is true, and undefined otherwise.

Type Parameters

S

S

Parameters

predicate

(value, index, array) => value is S

findLast calls predicate once for each element of the array, in descending order, until it finds one where predicate returns true. If such an element is found, findLast immediately returns that element value. Otherwise, findLast returns undefined.

thisArg?

any

If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns

undefined | S

Inherited from

IdentifierArray.findLast

Call Signature

findLast(predicate, thisArg?): undefined | T;

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es2023.array.d.ts:30

Parameters

predicate

(value, index, array) => unknown

thisArg?

any

Returns

undefined | T

Inherited from

IdentifierArray.findLast

---

findLastIndex()

findLastIndex(predicate, thisArg?): number;

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es2023.array.d.ts:41

Returns the index of the last element in the array where predicate is true, and -1 otherwise.

Parameters

predicate

(value, index, array) => unknown

findLastIndex calls predicate once for each element of the array, in descending order, until it finds one where predicate returns true. If such an element is found, findLastIndex immediately returns that element index. Otherwise, findLastIndex returns -1.

thisArg?

any

If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns

number

Inherited from

IdentifierArray.findLastIndex

---

flat()

flat<A, D>(this, depth?): FlatArray<A, D>[];

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es2019.array.d.ts:75

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type Parameters

A

A

D

D extends number = 1

Parameters

this

A

depth?

D

The maximum recursion depth

Returns

FlatArray<A, D>[]

Inherited from

IdentifierArray.flat

---

flatMap()

flatMap<U, This>(callback, thisArg?): U[];

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es2019.array.d.ts:64

Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.

Type Parameters

U

U

This

This = undefined

Parameters

callback

(this, value, index, array) => U | readonly U[]

A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.

thisArg?

This

An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.

Returns

U[]

Inherited from

IdentifierArray.flatMap

---

forEach()

forEach(callbackfn, thisArg?): void;

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts:1457

Performs the specified action for each element in an array.

Parameters

callbackfn

(value, index, array) => void

A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

thisArg?

any

An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns

void

Inherited from

IdentifierArray.forEach

---

includes()

includes(searchElement, fromIndex?): boolean;

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es2016.array.include.d.ts:25

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters

searchElement

T

The element to search for.

fromIndex?

number

The position in this array at which to begin searching for searchElement.

Returns

boolean

Inherited from

IdentifierArray.includes

---

indexOf()

indexOf(searchElement, fromIndex?): number;

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts:1418

Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

Parameters

searchElement

T

The value to locate in the array.

fromIndex?

number

The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns

number

Inherited from

IdentifierArray.indexOf

---

join()

join(separator?): string;

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts:1361

Adds all the elements of an array into a string, separated by the specified separator string.

Parameters

separator?

string

A string used to separate one element of the array from the next in the resulting string. If omitted, the array elements are separated with a comma.

Returns

string

Inherited from

IdentifierArray.join

---

keys()

keys(): ArrayIterator<number>;

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:88

Returns an iterable of keys in the array

Returns

ArrayIterator<number>

Inherited from

IdentifierArray.keys

---

lastIndexOf()

lastIndexOf(searchElement, fromIndex?): number;

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts:1424

Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

Parameters

searchElement

T

The value to locate in the array.

fromIndex?

number

The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

Returns

number

Inherited from

IdentifierArray.lastIndexOf

---

map()

map<U>(callbackfn, thisArg?): U[];

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts:1463

Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type Parameters

U

U

Parameters

callbackfn

(value, index, array) => U

A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

thisArg?

any

An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns

U[]

Inherited from

IdentifierArray.map

---

notify()

notify(): void;

Defined in: packages/store/unstable-preview-types/-private/record-arrays/many-array.d.ts:145

Returns

void

---

pop()

pop(): undefined | T;

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts:1339

Removes the last element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.

Returns

undefined | T

Inherited from

IdentifierArray.pop

---

push()

push(...items): number;

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts:1344

Appends new elements to the end of an array, and returns the new length of the array.

Parameters

items

...T[]

New elements to add to the array.

Returns

number

Inherited from

IdentifierArray.push

---

reduce()

Call Signature

reduce(callbackfn): T;

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts:1481

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters

callbackfn

(previousValue, currentValue, currentIndex, array) => T

A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns

T

Inherited from

IdentifierArray.reduce

Call Signature

reduce(callbackfn, initialValue): T;

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts:1482

Parameters

callbackfn

(previousValue, currentValue, currentIndex, array) => T

initialValue

T

Returns

T

Inherited from

IdentifierArray.reduce

Call Signature

reduce<U>(callbackfn, initialValue): U;

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts:1488

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type Parameters

U

U

Parameters

callbackfn

(previousValue, currentValue, currentIndex, array) => U

A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

initialValue

U

If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns

U

Inherited from

IdentifierArray.reduce

---

reduceRight()

Call Signature

reduceRight(callbackfn): T;

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts:1494

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters

callbackfn

(previousValue, currentValue, currentIndex, array) => T

A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns

T

Inherited from

IdentifierArray.reduceRight

Call Signature

reduceRight(callbackfn, initialValue): T;

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts:1495

Parameters

callbackfn

(previousValue, currentValue, currentIndex, array) => T

initialValue

T

Returns

T

Inherited from

IdentifierArray.reduceRight

Call Signature

reduceRight<U>(callbackfn, initialValue): U;

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts:1501

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type Parameters

U

U

Parameters

callbackfn

(previousValue, currentValue, currentIndex, array) => U

A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

initialValue

U

If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns

U

Inherited from

IdentifierArray.reduceRight

---

reload()

reload(options?): Promise<RelatedCollection<T>>;

Defined in: packages/store/unstable-preview-types/-private/record-arrays/many-array.d.ts:167

Reloads all of the records in the manyArray. If the manyArray holds a relationship that was originally fetched using a links url EmberData will revisit the original links url to repopulate the relationship.

If the ManyArray holds the result of a store.query() reload will re-run the original query.

Example

let user = store.peekRecord('user', '1')
await login(user);

let permissions = await user.permissions;
await permissions.reload();

Parameters

options?

BaseFinderOptions<unknown>

Returns

Promise<RelatedCollection<T>>

---

reverse()

reverse(): T[];

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts:1366

Reverses the elements in an array in place. This method mutates the array and returns a reference to the same array.

Returns

T[]

Inherited from

IdentifierArray.reverse

---

shift()

shift(): undefined | T;

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts:1371

Removes the first element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.

Returns

undefined | T

Inherited from

IdentifierArray.shift

---

slice()

slice(start?, end?): T[];

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts:1381

Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

Parameters

start?

number

The beginning index of the specified portion of the array. If start is undefined, then the slice begins at index 0.

end?

number

The end index of the specified portion of the array. This is exclusive of the element at the index 'end'. If end is undefined, then the slice extends to the end of the array.

Returns

T[]

Inherited from

IdentifierArray.slice

---

some()

some(predicate, thisArg?): boolean;

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts:1451

Determines whether the specified callback function returns true for any element of an array.

Parameters

predicate

(value, index, array) => unknown

A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array.

thisArg?

any

An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Returns

boolean

Inherited from

IdentifierArray.some

---

sort()

sort(compareFn?): this;

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts:1392

Sorts an array in place. This method mutates the array and returns a reference to the same array.

Parameters

compareFn?

(a, b) => number

Function used to determine the order of the elements. It is expected to return a negative value if the first argument is less than the second argument, zero if they're equal, and a positive value otherwise. If omitted, the elements are sorted in ascending, UTF-16 code unit order.

[11,2,22,1].sort((a, b) => a - b)

Returns

this

Inherited from

IdentifierArray.sort

---

splice()

Call Signature

splice(start, deleteCount?): T[];

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts:1399

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters

start

number

The zero-based location in the array from which to start removing elements.

deleteCount?

number

The number of elements to remove.

Returns

T[]

An array containing the elements that were deleted.

Inherited from

IdentifierArray.splice

Call Signature

splice(
   start, 
   deleteCount, ...
   items): T[];

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts:1407

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters

start

number

The zero-based location in the array from which to start removing elements.

deleteCount

number

The number of elements to remove.

items

...T[]

Elements to insert into the array in place of the deleted elements.

Returns

T[]

An array containing the elements that were deleted.

Inherited from

IdentifierArray.splice

---

toLocaleString()

Call Signature

toLocaleString(): string;

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts:1334

Returns a string representation of an array. The elements are converted to string using their toLocaleString methods.

Returns

string

Inherited from

IdentifierArray.toLocaleString

Call Signature

toLocaleString(locales, options?): string;

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es2015.core.d.ts:64

Parameters

locales

string | string[]

options?

NumberFormatOptions & DateTimeFormatOptions

Returns

string

Inherited from

IdentifierArray.toLocaleString

---

toReversed()

toReversed(): T[];

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es2023.array.d.ts:46

Returns a copy of an array with its elements reversed.

Returns

T[]

Inherited from

IdentifierArray.toReversed

---

toSorted()

toSorted(compareFn?): T[];

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es2023.array.d.ts:57

Returns a copy of an array with its elements sorted.

Parameters

compareFn?

(a, b) => number

Function used to determine the order of the elements. It is expected to return a negative value if the first argument is less than the second argument, zero if they're equal, and a positive value otherwise. If omitted, the elements are sorted in ascending, UTF-16 code unit order.

[11, 2, 22, 1].toSorted((a, b) => a - b) // [1, 2, 11, 22]

Returns

T[]

Inherited from

IdentifierArray.toSorted

---

toSpliced()

Call Signature

toSpliced(
   start, 
   deleteCount, ...
   items): T[];

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es2023.array.d.ts:66

Copies an array and removes elements and, if necessary, inserts new elements in their place. Returns the copied array.

Parameters

start

number

The zero-based location in the array from which to start removing elements.

deleteCount

number

The number of elements to remove.

items

...T[]

Elements to insert into the copied array in place of the deleted elements.

Returns

T[]

The copied array.

Inherited from

IdentifierArray.toSpliced

Call Signature

toSpliced(start, deleteCount?): T[];

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es2023.array.d.ts:74

Copies an array and removes elements while returning the remaining elements.

Parameters

start

number

The zero-based location in the array from which to start removing elements.

deleteCount?

number

The number of elements to remove.

Returns

T[]

A copy of the original array with the remaining elements.

Inherited from

IdentifierArray.toSpliced

---

toString()

toString(): string;

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts:1330

Returns a string representation of an array.

Returns

string

Inherited from

IdentifierArray.toString

---

unshift()

unshift(...items): number;

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts:1412

Inserts new elements at the start of an array, and returns the new length of the array.

Parameters

items

...T[]

Elements to insert at the start of the array.

Returns

number

Inherited from

IdentifierArray.unshift

---

update()

update(): Promise<IdentifierArray<T>>;

Defined in: packages/store/unstable-preview-types/-private/record-arrays/identifier-array.d.ts:108

Used to get the latest version of all of the records in this array from the adapter.

Example

let people = store.peekAll('person');
people.isUpdating; // false

people.update().then(function() {
  people.isUpdating; // false
});

people.isUpdating; // true

Returns

Promise<IdentifierArray<T>>

Inherited from

IdentifierArray.update

---

values()

values(): ArrayIterator<T>;

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:93

Returns an iterable of values in the array

Returns

ArrayIterator<T>

Inherited from

IdentifierArray.values

---

with()

with(index, value): T[];

Defined in: node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es2023.array.d.ts:85

Copies an array, then overwrites the value at the provided index with the given value. If the index is negative, then it replaces from the end of the array.

Parameters

index

number

The index of the value to overwrite. If the index is negative, then it replaces from the end of the array.

value

T

The value to write into the copied array.

Returns

T[]

The copied array with the updated value.

Inherited from

IdentifierArray.with