Crelte Docs

Appearance

crelte / / LoadDataArray

Interface: LoadDataArray<A1> ​

Extends ​

Type Parameters ​

A1 ​

A1 = any

Indexable ​

ts
[n: number]: LoadData<A1>

Properties ​

[unscopables] ​

ts
readonly [unscopables]: object;

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

Index Signature ​

ts
[key: number]: boolean | undefined

[iterator]? ​

ts
optional [iterator]: boolean;

[unscopables]? ​

ts
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? ​

ts
optional at: boolean;

concat? ​

ts
optional concat: boolean;

copyWithin? ​

ts
optional copyWithin: boolean;

entries? ​

ts
optional entries: boolean;

every? ​

ts
optional every: boolean;

fill? ​

ts
optional fill: boolean;

filter? ​

ts
optional filter: boolean;

find? ​

ts
optional find: boolean;

findIndex? ​

ts
optional findIndex: boolean;

findLast? ​

ts
optional findLast: boolean;

findLastIndex? ​

ts
optional findLastIndex: boolean;

flat? ​

ts
optional flat: boolean;

flatMap? ​

ts
optional flatMap: boolean;

forEach? ​

ts
optional forEach: boolean;

includes? ​

ts
optional includes: boolean;

indexOf? ​

ts
optional indexOf: boolean;

join? ​

ts
optional join: boolean;

keys? ​

ts
optional keys: boolean;

lastIndexOf? ​

ts
optional lastIndexOf: boolean;

length? ​

ts
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? ​

ts
optional map: boolean;

pop? ​

ts
optional pop: boolean;

push? ​

ts
optional push: boolean;

reduce? ​

ts
optional reduce: boolean;

reduceRight? ​

ts
optional reduceRight: boolean;

reverse? ​

ts
optional reverse: boolean;

shift? ​

ts
optional shift: boolean;

slice? ​

ts
optional slice: boolean;

some? ​

ts
optional some: boolean;

sort? ​

ts
optional sort: boolean;

splice? ​

ts
optional splice: boolean;

toLocaleString? ​

ts
optional toLocaleString: boolean;

toReversed? ​

ts
optional toReversed: boolean;

toSorted? ​

ts
optional toSorted: boolean;

toSpliced? ​

ts
optional toSpliced: boolean;

toString? ​

ts
optional toString: boolean;

unshift? ​

ts
optional unshift: boolean;

values? ​

ts
optional values: boolean;

with? ​

ts
optional with: boolean;

Inherited from ​

ts
Array.[unscopables]

length ​

ts
length: number;

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

Inherited from ​

ts
Array.length

Methods ​

[iterator]() ​

ts
iterator: ArrayIterator<LoadData<A1>>;

Iterator

Returns ​

ArrayIterator<LoadData<A1>>

Inherited from ​

ts
Array.[iterator]

at() ​

ts
at(index): LoadData<A1>;

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 ​

LoadData<A1>

Inherited from ​

ts
Array.at

concat() ​

Call Signature ​

ts
concat(...items): LoadData<A1>[];

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

Parameters ​
items ​

...ConcatArray<LoadData<A1>>[]

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

Returns ​

LoadData<A1>[]

Inherited from ​
ts
Array.concat

Call Signature ​

ts
concat(...items): LoadData<A1>[];

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

Parameters ​
items ​

...( | LoadData<A1> | ConcatArray<LoadData<A1>>)[]

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

Returns ​

LoadData<A1>[]

Inherited from ​
ts
Array.concat

copyWithin() ​

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

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 ​

ts
Array.copyWithin

entries() ​

ts
entries(): ArrayIterator<[number, LoadData<A1>]>;

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

Returns ​

ArrayIterator<[number, LoadData<A1>]>

Inherited from ​

ts
Array.entries

every() ​

Call Signature ​

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

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

Type Parameters ​
S ​

S extends LoadData<A1>

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 ​
ts
Array.every

Call Signature ​

ts
every(predicate, thisArg?): boolean;

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 ​
ts
Array.every

fill() ​

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

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

Parameters ​

value ​

LoadData

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 ​

ts
Array.fill

filter() ​

Call Signature ​

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

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

Type Parameters ​
S ​

S extends LoadData<A1>

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 ​
ts
Array.filter

Call Signature ​

ts
filter(predicate, thisArg?): LoadData<A1>[];

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 ​

LoadData<A1>[]

Inherited from ​
ts
Array.filter

find() ​

Call Signature ​

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

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

Type Parameters ​
S ​

S extends LoadData<A1>

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 ​

S | undefined

Inherited from ​
ts
Array.find

Call Signature ​

ts
find(predicate, thisArg?): LoadData<A1>;
Parameters ​
predicate ​

(value, index, obj) => unknown

thisArg? ​

any

Returns ​

LoadData<A1>

Inherited from ​
ts
Array.find

findIndex() ​

ts
findIndex(predicate, thisArg?): number;

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 ​

ts
Array.findIndex

findLast() ​

Call Signature ​

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

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

Type Parameters ​
S ​

S extends LoadData<A1>

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 ​

S | undefined

Inherited from ​
ts
Array.findLast

Call Signature ​

ts
findLast(predicate, thisArg?): LoadData<A1>;
Parameters ​
predicate ​

(value, index, array) => unknown

thisArg? ​

any

Returns ​

LoadData<A1>

Inherited from ​
ts
Array.findLast

findLastIndex() ​

ts
findLastIndex(predicate, thisArg?): number;

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 ​

ts
Array.findLastIndex

flat() ​

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

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 ​

ts
Array.flat

flatMap() ​

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

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 ​

ts
Array.flatMap

forEach() ​

ts
forEach(callbackfn, thisArg?): void;

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 ​

ts
Array.forEach

includes() ​

ts
includes(searchElement, fromIndex?): boolean;

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

Parameters ​

searchElement ​

LoadData

The element to search for.

fromIndex? ​

number

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

Returns ​

boolean

Inherited from ​

ts
Array.includes

indexOf() ​

ts
indexOf(searchElement, fromIndex?): number;

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

Parameters ​

searchElement ​

LoadData

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 ​

ts
Array.indexOf

join() ​

ts
join(separator?): string;

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 ​

ts
Array.join

keys() ​

ts
keys(): ArrayIterator<number>;

Returns an iterable of keys in the array

Returns ​

ArrayIterator<number>

Inherited from ​

ts
Array.keys

lastIndexOf() ​

ts
lastIndexOf(searchElement, fromIndex?): number;

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

Parameters ​

searchElement ​

LoadData

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 ​

ts
Array.lastIndexOf

map() ​

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

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 ​

ts
Array.map

pop() ​

ts
pop(): LoadData<A1>;

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 ​

LoadData<A1>

Inherited from ​

ts
Array.pop

push() ​

ts
push(...items): number;

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

Parameters ​

items ​

...LoadData<A1>[]

New elements to add to the array.

Returns ​

number

Inherited from ​

ts
Array.push

reduce() ​

Call Signature ​

ts
reduce(callbackfn): LoadData;

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) => LoadData

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

Returns ​

LoadData

Inherited from ​
ts
Array.reduce

Call Signature ​

ts
reduce(callbackfn, initialValue): LoadData;
Parameters ​
callbackfn ​

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

initialValue ​

LoadData

Returns ​

LoadData

Inherited from ​
ts
Array.reduce

Call Signature ​

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

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 ​
ts
Array.reduce

reduceRight() ​

Call Signature ​

ts
reduceRight(callbackfn): LoadData;

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) => LoadData

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

Returns ​

LoadData

Inherited from ​
ts
Array.reduceRight

Call Signature ​

ts
reduceRight(callbackfn, initialValue): LoadData;
Parameters ​
callbackfn ​

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

initialValue ​

LoadData

Returns ​

LoadData

Inherited from ​
ts
Array.reduceRight

Call Signature ​

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

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 ​
ts
Array.reduceRight

reverse() ​

ts
reverse(): LoadData<A1>[];

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

Returns ​

LoadData<A1>[]

Inherited from ​

ts
Array.reverse

shift() ​

ts
shift(): LoadData<A1>;

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 ​

LoadData<A1>

Inherited from ​

ts
Array.shift

slice() ​

ts
slice(start?, end?): LoadData<A1>[];

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 ​

LoadData<A1>[]

Inherited from ​

ts
Array.slice

some() ​

ts
some(predicate, thisArg?): boolean;

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 ​

ts
Array.some

sort() ​

ts
sort(compareFn?): this;

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.

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

Returns ​

this

Inherited from ​

ts
Array.sort

splice() ​

Call Signature ​

ts
splice(start, deleteCount?): LoadData<A1>[];

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. Omitting this argument will remove all elements from the start paramater location to end of the array. If value of this argument is either a negative number, zero, undefined, or a type that cannot be converted to an integer, the function will evaluate the argument as zero and not remove any elements.

Returns ​

LoadData<A1>[]

An array containing the elements that were deleted.

Inherited from ​
ts
Array.splice

Call Signature ​

ts
splice(
   start, 
   deleteCount, ...
   items): LoadData<A1>[];

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. If value of this argument is either a negative number, zero, undefined, or a type that cannot be converted to an integer, the function will evaluate the argument as zero and not remove any elements.

items ​

...LoadData<A1>[]

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

Returns ​

LoadData<A1>[]

An array containing the elements that were deleted.

Inherited from ​
ts
Array.splice

toLocaleString() ​

Call Signature ​

ts
toLocaleString(): string;

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

Returns ​

string

Inherited from ​
ts
Array.toLocaleString

Call Signature ​

ts
toLocaleString(locales, options?): string;
Parameters ​
locales ​

string | string[]

options? ​

NumberFormatOptions & DateTimeFormatOptions

Returns ​

string

Inherited from ​
ts
Array.toLocaleString

toReversed() ​

ts
toReversed(): LoadData<A1>[];

Returns a copy of an array with its elements reversed.

Returns ​

LoadData<A1>[]

Inherited from ​

ts
Array.toReversed

toSorted() ​

ts
toSorted(compareFn?): LoadData<A1>[];

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.

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

Returns ​

LoadData<A1>[]

Inherited from ​

ts
Array.toSorted

toSpliced() ​

Call Signature ​

ts
toSpliced(
   start, 
   deleteCount, ...
   items): LoadData<A1>[];

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 ​

...LoadData<A1>[]

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

Returns ​

LoadData<A1>[]

The copied array.

Inherited from ​
ts
Array.toSpliced

Call Signature ​

ts
toSpliced(start, deleteCount?): LoadData<A1>[];

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 ​

LoadData<A1>[]

A copy of the original array with the remaining elements.

Inherited from ​
ts
Array.toSpliced

toString() ​

ts
toString(): string;

Returns a string representation of an array.

Returns ​

string

Inherited from ​

ts
Array.toString

unshift() ​

ts
unshift(...items): number;

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

Parameters ​

items ​

...LoadData<A1>[]

Elements to insert at the start of the array.

Returns ​

number

Inherited from ​

ts
Array.unshift

values() ​

ts
values(): ArrayIterator<LoadData<A1>>;

Returns an iterable of values in the array

Returns ​

ArrayIterator<LoadData<A1>>

Inherited from ​

ts
Array.values

with() ​

ts
with(index, value): LoadData<A1>[];

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 ​

LoadData

The value to write into the copied array.

Returns ​

LoadData<A1>[]

The copied array with the updated value.

Inherited from ​

ts
Array.with