Readonly [unscopables]Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.
Optional Readonly [unscopables]?: booleanIs an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.
Optional length?: booleanGets or sets the length of the array. This is a number one higher than the highest index in the array.
Gets or sets the length of the array. This is a number one higher than the highest index in the array.
Static Readonly [species]Pops the array atomically at most one time per document save().
Atomically shifts the array at most one time per document save().
Iterator
Returns the item located at the specified index.
The zero-based index of the desired code unit. A negative index will count back from the last item.
Combines two or more arrays. This method returns a new array without modifying any existing arrays.
Rest ...items: ConcatArray<T extends mongoose.Types.Subdocument<any, any, any>Additional arrays and/or items to add to the end of the array.
Rest Combines two or more arrays. This method returns a new array without modifying any existing arrays.
Rest ...items: ((T extends mongoose.Types.Subdocument<any, any, any>Additional arrays and/or items to add to the end of the array.
Rest Returns the this object after copying a section of the array identified by start and end to the same array starting at position target
If target is negative, it is treated as length+target where length is the length of the array.
If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end: numberIf not specified, length of the this object is used as its default value.
Optional Creates a subdocument casted to this schema.
Returns an iterable of key, value pairs for every entry in the array
Determines whether all the members of an array satisfy the specified test.
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.
Optional thisArg: anyAn object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
Optional Determines whether all the members of an array satisfy the specified test.
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.
Optional thisArg: anyAn object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
Optional Changes all array elements from start to end index to a static value and returns the modified array
value to fill array section with
Optional start: numberindex to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional Optional end: numberindex to stop filling the array at. If end is negative, it is treated as length+end.
Optional Returns the elements of an array that meet the condition specified in a callback function.
A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.
Optional thisArg: anyAn object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
Optional Returns the elements of an array that meet the condition specified in a callback function.
A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.
Optional thisArg: anyAn object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
Optional Returns the value of the first element in the array where predicate is true, and undefined otherwise.
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.
Optional thisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Optional Optional thisArg: anyOptional Returns the index of the first element in the array where predicate is true, and -1 otherwise.
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.
Optional thisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Optional Returns the value of the last element in the array where predicate is true, and undefined otherwise.
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.
Optional thisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Optional Optional thisArg: anyOptional Returns the index of the last element in the array where predicate is true, and -1 otherwise.
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.
Optional thisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Optional 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.
A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.
Optional thisArg: ThisAn object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.
Optional Performs the specified action for each element in an array.
A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg: anyAn object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Optional Searches array items for the first document with a matching _id.
Determines whether an array includes a certain element, returning true or false as appropriate.
The element to search for.
Optional fromIndex: numberThe position in this array at which to begin searching for searchElement.
Optional Returns the index of the first occurrence of a value in an array, or -1 if it is not present.
The value to locate in the array.
Optional fromIndex: numberThe array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Optional Adds all the elements of an array into a string, separated by the specified separator string.
Optional separator: stringA 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.
Optional Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.
The value to locate in the array.
Optional fromIndex: numberThe array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.
Optional Calls a defined callback function on each element of an array, and returns an array that contains the results.
A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
Optional thisArg: anyAn object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Optional Removes the last element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.
Pulls items from the array atomically. Equality is determined by casting
the provided value to an embedded document and comparing using
the Document.equals() function.
Rest ...args: any[]Rest Wraps Array#push with proper change tracking.
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.
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
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.
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
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.
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.
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
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.
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
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.
Alias of pull
Rest ...args: any[]Rest Reverses the elements in an array in place. This method mutates the array and returns a reference to the same array.
Sets the casted val at index i and marks the array modified.
Atomically shifts the array at most one time per document save().
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.
Optional start: numberThe beginning index of the specified portion of the array. If start is undefined, then the slice begins at index 0.
Optional Optional end: numberThe 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.
Optional Determines whether the specified callback function returns true for any element of an array.
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.
Optional thisArg: anyAn object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
Optional Sorts an array in place. This method mutates the array and returns a reference to the same array.
Optional 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, ASCII character order.
[11,2,22,1].sort((a, b) => a - b)
Optional
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
The zero-based location in the array from which to start removing elements.
Optional deleteCount: numberThe number of elements to remove.
Optional An array containing the elements that were deleted.
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
The zero-based location in the array from which to start removing elements.
The number of elements to remove.
Rest ...items: (T extends mongoose.Types.Subdocument<any, any, any>Elements to insert into the array in place of the deleted elements.
Rest An array containing the elements that were deleted.
Returns a native js Array.
Optional options: ToObjectOptions<mongoose.Document<unknown, {}, unknown> & Required<{ Optional Optional options: ToObjectOptions<T>Optional Wraps Array#unshift with proper change tracking.
Rest ...args: any[]Rest Returns an iterable of values in the array
Static fromCreates an array from an array-like object.
An array-like object to convert to an array.
Creates an array from an iterable object.
An array-like object to convert to an array.
A mapping function to call on every element of the array.
Optional thisArg: anyValue of 'this' used to invoke the mapfn.
Optional Creates an array from an iterable object.
An iterable object to convert to an array.
Creates an array from an iterable object.
An iterable object to convert to an array.
A mapping function to call on every element of the array.
Optional thisArg: anyValue of 'this' used to invoke the mapfn.
Optional Static isStatic ofGenerated using TypeDoc
DocumentArray constructor