TypeFieldListResult interface
- Extends
-
Array<TypeField>
繼承的屬性
length | 取得或設定陣列的長度。 這是高於數位中最高索引的數位。 |
繼承的方法
繼承的屬性詳細資料
length
取得或設定陣列的長度。 這是高於數位中最高索引的數位。
length: number
屬性值
number
繼承自 Array.length
繼承的方法的詳細資料
at(number)
接受整數值,並傳回位於該索引的項目,允許正整數和負整數。 負整數會從陣列中的最後一個專案倒數。
function at(index: number): undefined | TypeField
參數
- index
-
number
傳回
undefined | TypeField
繼承自 Array.at
concat((TypeField | ConcatArray<TypeField>)[])
結合兩個或多個陣列。 這個方法會傳回新的陣列,而不需要修改任何現有的陣列。
function concat(items: (TypeField | ConcatArray<TypeField>)[]): TypeField[]
參數
傳回
繼承自 Array.concat
concat(ConcatArray<TypeField>[])
結合兩個或多個陣列。 這個方法會傳回新的陣列,而不需要修改任何現有的陣列。
function concat(items: ConcatArray<TypeField>[]): TypeField[]
參數
- items
-
ConcatArray<TypeField>[]
要加入陣列結尾的其他陣列和/或專案。
傳回
繼承自 Array.concat
copyWithin(number, number, number)
複製開始和結束至從位置目標開始之相同數位的陣列區段之後,傳回這個物件
function copyWithin(target: number, start: number, end?: number): TypeFieldListResult
參數
- target
-
number
如果 target 是負數,則會將其視為 length+target,其中 length 是陣列的長度。
- start
-
number
如果 start 為負數,則會將其視為 length+start。 如果 end 是負數,則會將其視為 length+end。
- end
-
number
如果未指定,則會使用此對象的長度做為其預設值。
傳回
繼承自 Array.copyWithin
entries()
傳回數位中每個專案的索引鍵、值組反覆運算
function entries(): IterableIterator<[number, TypeField]>
傳回
IterableIterator<[number, TypeField]>
繼承自 Array.entries
every((value: TypeField, index: number, array: TypeField[]) => unknown, any)
判斷陣列的所有成員是否符合指定的測試。
function every(predicate: (value: TypeField, index: number, array: TypeField[]) => unknown, thisArg?: any): boolean
參數
- predicate
-
(value: TypeField, index: number, array: TypeField[]) => unknown
最多可以接受三個引數的函式。 每個方法都會呼叫陣列中每個專案的述詞函式,直到述詞傳回值,這個值會強制布爾值 false,或直到數位結尾為止。
- thisArg
-
any
這個關鍵詞可以在述詞函式中參考的物件。 如果省略 thisArg,則會使用 undefined 做為此值。
傳回
boolean
繼承自 Array.every
every<S>((value: TypeField, index: number, array: TypeField[]) => value, any)
判斷陣列的所有成員是否符合指定的測試。
function every<S>(predicate: (value: TypeField, index: number, array: TypeField[]) => value, thisArg?: any): this
參數
- predicate
-
(value: TypeField, index: number, array: TypeField[]) => value
最多可以接受三個引數的函式。 每個方法都會呼叫陣列中每個專案的述詞函式,直到述詞傳回值,這個值會強制布爾值 false,或直到數位結尾為止。
- thisArg
-
any
這個關鍵詞可以在述詞函式中參考的物件。 如果省略 thisArg,則會使用 undefined 做為此值。
傳回
this
繼承自 Array.every
fill(TypeField, number, number)
將所有數位專案從 start
變更為索引,end
value
並傳回修改的陣列
function fill(value: TypeField, start?: number, end?: number): TypeFieldListResult
參數
- value
- TypeField
要填入數位區段的值
- start
-
number
要開始填滿陣列的索引。 如果 start 是負數,則會將其視為 length+start,其中 length 是數位的長度。
- end
-
number
要停止填滿陣列的索引。 如果 end 是負數,則會將其視為 length+end。
傳回
繼承自 Array.fill
filter((value: TypeField, index: number, array: TypeField[]) => unknown, any)
傳回符合回呼函式中所指定條件之陣列的專案。
function filter(predicate: (value: TypeField, index: number, array: TypeField[]) => unknown, thisArg?: any): TypeField[]
參數
- predicate
-
(value: TypeField, index: number, array: TypeField[]) => unknown
最多可以接受三個引數的函式。 篩選方法會針對數位中的每個元素呼叫述詞函式一次。
- thisArg
-
any
這個關鍵詞可以在述詞函式中參考的物件。 如果省略 thisArg,則會使用 undefined 做為此值。
傳回
繼承自 Array.filter
filter<S>((value: TypeField, index: number, array: TypeField[]) => value, any)
傳回符合回呼函式中所指定條件之陣列的專案。
function filter<S>(predicate: (value: TypeField, index: number, array: TypeField[]) => value, thisArg?: any): S[]
參數
- predicate
-
(value: TypeField, index: number, array: TypeField[]) => value
最多可以接受三個引數的函式。 篩選方法會針對數位中的每個元素呼叫述詞函式一次。
- thisArg
-
any
這個關鍵詞可以在述詞函式中參考的物件。 如果省略 thisArg,則會使用 undefined 做為此值。
傳回
S[]
繼承自 Array.filter
find((value: TypeField, index: number, obj: TypeField[]) => unknown, any)
function find(predicate: (value: TypeField, index: number, obj: TypeField[]) => unknown, thisArg?: any): undefined | TypeField
參數
- predicate
-
(value: TypeField, index: number, obj: TypeField[]) => unknown
- thisArg
-
any
傳回
undefined | TypeField
繼承自 Array.find
find<S>((this: void, value: TypeField, index: number, obj: TypeField[]) => value, any)
傳回數位中述詞為 true 且未定義之第一個專案的值。
function find<S>(predicate: (this: void, value: TypeField, index: number, obj: TypeField[]) => value, thisArg?: any): undefined | S
參數
- predicate
-
(this: void, value: TypeField, index: number, obj: TypeField[]) => value
會依遞增順序尋找陣列的每個元素呼叫述詞一次,直到找到述詞傳回 true 的位置為止。 如果找到這類專案,請立即尋找傳回該元素值。 否則,find 會傳回未定義。
- thisArg
-
any
如果提供,它會作為每個述詞調用的這個值。 如果未提供,則會改用未定義。
傳回
undefined | S
繼承自 Array.find
findIndex((value: TypeField, index: number, obj: TypeField[]) => unknown, any)
傳回陣列中述詞為 true 之第一個專案的索引,否則傳回 -1。
function findIndex(predicate: (value: TypeField, index: number, obj: TypeField[]) => unknown, thisArg?: any): number
參數
- predicate
-
(value: TypeField, index: number, obj: TypeField[]) => unknown
會依遞增順序尋找陣列的每個元素呼叫述詞一次,直到找到述詞傳回 true 的位置為止。 如果找到這類專案,findIndex 會立即傳回該元素索引。 否則,findIndex 會傳回 -1。
- thisArg
-
any
如果提供,它會作為每個述詞調用的這個值。 如果未提供,則會改用未定義。
傳回
number
繼承自 Array.findIndex
flat<A, D>(A, D)
傳回新的陣列,其中所有子陣列元素會以遞歸方式串連到指定的深度。
function flat<A, D>(this: A, depth?: D): FlatArray<A, D>[]
參數
- this
-
A
- depth
-
D
遞歸深度上限
傳回
FlatArray<A, D>[]
繼承自 Array.flat
flatMap<U, This>((this: This, value: TypeField, index: number, array: TypeField[]) => U | (readonly U[]), This)
在陣列的每個專案上呼叫已定義的回呼函式。 然後,將結果扁平化為新的數位。 這與地圖相同,後面接著深度為1的平面。
function flatMap<U, This>(callback: (this: This, value: TypeField, index: number, array: TypeField[]) => U | (readonly U[]), thisArg?: This): U[]
參數
- callback
-
(this: This, value: TypeField, index: number, array: TypeField[]) => U | (readonly U[])
最多可以接受三個引數的函式。 flatMap 方法會針對數位中的每個元素呼叫回呼函式一次。
- thisArg
-
This
這個關鍵詞可以在回呼函式中參考的物件。 如果省略 thisArg,則會使用 undefined 做為此值。
傳回
U[]
繼承自 Array.flatMap
forEach((value: TypeField, index: number, array: TypeField[]) => void, any)
針對陣列中的每個元素執行指定的動作。
function forEach(callbackfn: (value: TypeField, index: number, array: TypeField[]) => void, thisArg?: any)
參數
- callbackfn
-
(value: TypeField, index: number, array: TypeField[]) => void
最多可以接受三個引數的函式。 forEach 會針對陣列中的每個元素呼叫 callbackfn 函式一次。
- thisArg
-
any
這個關鍵詞可以在 callbackfn 函式中參考的物件。 如果省略 thisArg,則會使用 undefined 做為此值。
繼承自 Array.forEach
includes(TypeField, number)
判斷陣列是否包含特定元素,並視情況傳回 true 或 false。
function includes(searchElement: TypeField, fromIndex?: number): boolean
參數
- searchElement
- TypeField
要搜尋的專案。
- fromIndex
-
number
此陣列中要開始搜尋 searchElement 的位置。
傳回
boolean
繼承自 Array.includes
indexOf(TypeField, number)
傳回陣列中第一次出現值的索引,如果不存在,則傳回 -1。
function indexOf(searchElement: TypeField, fromIndex?: number): number
參數
- searchElement
- TypeField
陣列中要尋找的值。
- fromIndex
-
number
要開始搜尋的陣列索引。 如果省略 fromIndex,搜尋會從索引 0 開始。
傳回
number
繼承自 Array.indexOf
join(string)
將陣列的所有專案加入字串,並以指定的分隔符字串分隔。
function join(separator?: string): string
參數
- separator
-
string
字串,用來分隔陣列的其中一個專案與結果字串中的下一個專案。 如果省略,陣列元素會以逗號分隔。
傳回
string
繼承自 Array.join
keys()
傳回數位中索引鍵的可反覆運算
function keys(): IterableIterator<number>
傳回
IterableIterator<number>
繼承自 Array.keys
lastIndexOf(TypeField, number)
傳回陣列中最後一次出現指定值的索引,如果不存在,則傳回 -1。
function lastIndexOf(searchElement: TypeField, fromIndex?: number): number
參數
- searchElement
- TypeField
陣列中要尋找的值。
- fromIndex
-
number
開始向後搜尋的陣列索引。 如果省略 fromIndex,搜尋會從陣列中的最後一個索引開始。
傳回
number
繼承自 Array.lastIndexOf
map<U>((value: TypeField, index: number, array: TypeField[]) => U, any)
在陣列中的每個元素上呼叫定義的回呼函式,並傳回包含結果的陣列。
function map<U>(callbackfn: (value: TypeField, index: number, array: TypeField[]) => U, thisArg?: any): U[]
參數
- callbackfn
-
(value: TypeField, index: number, array: TypeField[]) => U
最多可以接受三個引數的函式。 map 方法會針對數位中的每個元素呼叫 callbackfn 函式一次。
- thisArg
-
any
這個關鍵詞可以在 callbackfn 函式中參考的物件。 如果省略 thisArg,則會使用 undefined 作為此值。
傳回
U[]
繼承自 Array.map
pop()
移除陣列的最後一個元素,然後將它傳回。 如果陣列是空的,則會傳回 undefined,而且不會修改陣列。
function pop(): undefined | TypeField
傳回
undefined | TypeField
繼承自 Array.pop
push(TypeField[])
將新元素附加至陣列的結尾,並傳回數位的新長度。
function push(items: TypeField[]): number
參數
- items
要加入至陣列的新元素。
傳回
number
繼承自 Array.push
reduce((previousValue: TypeField, currentValue: TypeField, currentIndex: number, array: TypeField[]) => TypeField)
呼叫陣列中所有專案的指定回呼函式。 回呼函式的傳回值即為累加結果,並做為下一個呼叫的引數提供給回呼函式。
function reduce(callbackfn: (previousValue: TypeField, currentValue: TypeField, currentIndex: number, array: TypeField[]) => TypeField): TypeField
參數
- callbackfn
-
(previousValue: TypeField, currentValue: TypeField, currentIndex: number, array: TypeField[]) => TypeField
最多接受四個自變數的函式。 reduce 方法會針對數位中的每個元素呼叫 callbackfn 函式一次。
傳回
繼承自 Array.reduce
reduce((previousValue: TypeField, currentValue: TypeField, currentIndex: number, array: TypeField[]) => TypeField, TypeField)
function reduce(callbackfn: (previousValue: TypeField, currentValue: TypeField, currentIndex: number, array: TypeField[]) => TypeField, initialValue: TypeField): TypeField
參數
- callbackfn
-
(previousValue: TypeField, currentValue: TypeField, currentIndex: number, array: TypeField[]) => TypeField
- initialValue
- TypeField
傳回
繼承自 Array.reduce
reduce<U>((previousValue: U, currentValue: TypeField, currentIndex: number, array: TypeField[]) => U, U)
呼叫陣列中所有專案的指定回呼函式。 回呼函式的傳回值即為累加結果,並做為下一個呼叫的引數提供給回呼函式。
function reduce<U>(callbackfn: (previousValue: U, currentValue: TypeField, currentIndex: number, array: TypeField[]) => U, initialValue: U): U
參數
- callbackfn
-
(previousValue: U, currentValue: TypeField, currentIndex: number, array: TypeField[]) => U
最多接受四個自變數的函式。 reduce 方法會針對數位中的每個元素呼叫 callbackfn 函式一次。
- initialValue
-
U
如果指定 initialValue,則會用來做為初始值來啟動累積。 對 callbackfn 函式的第一次呼叫會提供此值做為自變數,而不是數位值。
傳回
U
繼承自 Array.reduce
reduceRight((previousValue: TypeField, currentValue: TypeField, currentIndex: number, array: TypeField[]) => TypeField)
以遞減順序呼叫陣列中所有專案的指定回呼函式。 回呼函式的傳回值即為累加結果,並做為下一個呼叫的引數提供給回呼函式。
function reduceRight(callbackfn: (previousValue: TypeField, currentValue: TypeField, currentIndex: number, array: TypeField[]) => TypeField): TypeField
參數
- callbackfn
-
(previousValue: TypeField, currentValue: TypeField, currentIndex: number, array: TypeField[]) => TypeField
最多接受四個自變數的函式。 reduceRight 方法會針對數位中的每個元素呼叫 callbackfn 函式一次。
傳回
繼承自 Array.reduceRight
reduceRight((previousValue: TypeField, currentValue: TypeField, currentIndex: number, array: TypeField[]) => TypeField, TypeField)
function reduceRight(callbackfn: (previousValue: TypeField, currentValue: TypeField, currentIndex: number, array: TypeField[]) => TypeField, initialValue: TypeField): TypeField
參數
- callbackfn
-
(previousValue: TypeField, currentValue: TypeField, currentIndex: number, array: TypeField[]) => TypeField
- initialValue
- TypeField
傳回
繼承自 Array.reduceRight
reduceRight<U>((previousValue: U, currentValue: TypeField, currentIndex: number, array: TypeField[]) => U, U)
以遞減順序呼叫陣列中所有專案的指定回呼函式。 回呼函式的傳回值即為累加結果,並做為下一個呼叫的引數提供給回呼函式。
function reduceRight<U>(callbackfn: (previousValue: U, currentValue: TypeField, currentIndex: number, array: TypeField[]) => U, initialValue: U): U
參數
- callbackfn
-
(previousValue: U, currentValue: TypeField, currentIndex: number, array: TypeField[]) => U
最多接受四個自變數的函式。 reduceRight 方法會針對數位中的每個元素呼叫 callbackfn 函式一次。
- initialValue
-
U
如果指定 initialValue,則會用來做為初始值來啟動累積。 對 callbackfn 函式的第一次呼叫會提供此值做為自變數,而不是數位值。
傳回
U
繼承自 Array.reduceRight
reverse()
shift()
移除陣列的第一個項目,然後將它傳回。 如果陣列是空的,則會傳回 undefined,而且不會修改陣列。
function shift(): undefined | TypeField
傳回
undefined | TypeField
繼承自 Array.shift
slice(number, number)
傳回數位區段的複本。 針對開始和結束,可以使用負數索引來表示陣列結尾的位移。 例如,-2 是指數組的第二個到最後一個專案。
function slice(start?: number, end?: number): TypeField[]
參數
- start
-
number
陣列指定部分的開始索引。 如果未定義 start,則配量會從索引 0 開始。
- end
-
number
陣列指定部分的結束索引。 這是索引 『end』 中元素的獨佔專案。 如果未定義 end,則配量會延伸至陣列的結尾。
傳回
繼承自 Array.slice
some((value: TypeField, index: number, array: TypeField[]) => unknown, any)
判斷指定的回呼函式是否針對數位的任何項目傳回 true。
function some(predicate: (value: TypeField, index: number, array: TypeField[]) => unknown, thisArg?: any): boolean
參數
- predicate
-
(value: TypeField, index: number, array: TypeField[]) => unknown
最多可以接受三個引數的函式。 某些方法會呼叫陣列中每個專案的述詞函式,直到述詞傳回可強制布爾值 true 的值,或直到數位結尾為止。
- thisArg
-
any
這個關鍵詞可以在述詞函式中參考的物件。 如果省略 thisArg,則會使用 undefined 作為此值。
傳回
boolean
繼承自 Array.some
sort((a: TypeField, b: TypeField) => number)
就地排序陣列。 這個方法會變動陣列,並傳回相同數位的參考。
function sort(compareFn?: (a: TypeField, b: TypeField) => number): TypeFieldListResult
參數
- compareFn
-
(a: TypeField, b: TypeField) => number
用來判斷項目順序的函式。 如果第一個自變數小於第二個自變數,則傳回負值,如果相等則傳回零,否則傳回正值。 如果省略,元素會以遞增、ASCII 字元順序排序。
[11,2,22,1].sort((a, b) => a - b)
傳回
繼承自 Array.sort
splice(number, number)
移除陣列中的元素,並依需要在適當位置插入新元素,然後傳回被刪除的元素。
function splice(start: number, deleteCount?: number): TypeField[]
參數
- start
-
number
陣列中以零起始的位置,要從中開始移除專案。
- deleteCount
-
number
要移除的項目數目。
傳回
陣列,其中包含已刪除的專案。
繼承自 Array.splice
splice(number, number, TypeField[])
移除陣列中的元素,並依需要在適當位置插入新元素,然後傳回被刪除的元素。
function splice(start: number, deleteCount: number, items: TypeField[]): TypeField[]
參數
- start
-
number
陣列中以零起始的位置,要從中開始移除專案。
- deleteCount
-
number
要移除的項目數目。
- items
要插入陣列中的元素取代已刪除的專案。
傳回
陣列,其中包含已刪除的專案。
繼承自 Array.splice
toLocaleString()
傳回陣列的字串表示。 元素會使用它們的 toLocaleString 方法轉換成字串。
function toLocaleString(): string
傳回
string
繼承自 Array.toLocaleString
toString()
傳回陣列的字串表示。
function toString(): string
傳回
string
繼承自 Array.toString
unshift(TypeField[])
在陣列開頭插入新元素,並傳回陣列的新長度。
function unshift(items: TypeField[]): number
參數
- items
要插入數位開頭的專案。
傳回
number
繼承自 Array.unshift
values()
傳回數位中值的可反覆運算
function values(): IterableIterator<TypeField>
傳回
IterableIterator<TypeField>
繼承自 Array.values
[iterator]()
Iterator
function [iterator](): IterableIterator<TypeField>
傳回
IterableIterator<TypeField>
繼承自 Array.__@iterator@1503
[unscopables]()
傳回物件,其屬性在 『with』 語句中使用時,其值為 『true』。
function [unscopables](): { copyWithin: boolean, entries: boolean, fill: boolean, find: boolean, findIndex: boolean, keys: boolean, values: boolean }
傳回
{ copyWithin: boolean, entries: boolean, fill: boolean, find: boolean, findIndex: boolean, keys: boolean, values: boolean }
繼承自 Array.__@unscopables@1505