v3b
Defined in: packages/typegpu/src/data/wgslTypes.ts:567
Interface representing its WGSL vector type counterpart: vec3<bool>
.
A vector with 3 elements of type bool
Extends
Section titled “Extends”Indexable
Section titled “Indexable”[n
: number
]: boolean
Properties
Section titled “Properties”[$internal]
Section titled “[$internal]”
readonly
[$internal]:true
Defined in: packages/typegpu/src/data/wgslTypes.ts:568
[unscopables]
Section titled “[unscopables]”
readonly
[unscopables]:object
Defined in: node_modules/.pnpm/[email protected]/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
Section titled “Index Signature”[key
: number
]: undefined
| boolean
[iterator]?
Section titled “[iterator]?”
optional
[iterator]:boolean
[unscopables]?
Section titled “[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.
optional
at:boolean
concat?
Section titled “concat?”
optional
concat:boolean
copyWithin?
Section titled “copyWithin?”
optional
copyWithin:boolean
entries?
Section titled “entries?”
optional
entries:boolean
every?
Section titled “every?”
optional
every:boolean
optional
fill:boolean
filter?
Section titled “filter?”
optional
filter:boolean
optional
find:boolean
findIndex?
Section titled “findIndex?”
optional
findIndex:boolean
findLast?
Section titled “findLast?”
optional
findLast:boolean
findLastIndex?
Section titled “findLastIndex?”
optional
findLastIndex:boolean
optional
flat:boolean
flatMap?
Section titled “flatMap?”
optional
flatMap:boolean
forEach?
Section titled “forEach?”
optional
forEach:boolean
includes?
Section titled “includes?”
optional
includes:boolean
indexOf?
Section titled “indexOf?”
optional
indexOf:boolean
optional
join:boolean
optional
keys:boolean
lastIndexOf?
Section titled “lastIndexOf?”
optional
lastIndexOf:boolean
length?
Section titled “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.
optional
map:boolean
optional
pop:boolean
optional
push:boolean
reduce?
Section titled “reduce?”
optional
reduce:boolean
reduceRight?
Section titled “reduceRight?”
optional
reduceRight:boolean
reverse?
Section titled “reverse?”
optional
reverse:boolean
shift?
Section titled “shift?”
optional
shift:boolean
slice?
Section titled “slice?”
optional
slice:boolean
optional
some:boolean
optional
sort:boolean
splice?
Section titled “splice?”
optional
splice:boolean
toLocaleString?
Section titled “toLocaleString?”
optional
toLocaleString:boolean
toReversed?
Section titled “toReversed?”
optional
toReversed:boolean
toSorted?
Section titled “toSorted?”
optional
toSorted:boolean
toSpliced?
Section titled “toSpliced?”
optional
toSpliced:boolean
toString?
Section titled “toString?”
optional
toString:boolean
unshift?
Section titled “unshift?”
optional
unshift:boolean
values?
Section titled “values?”
optional
values:boolean
optional
with:boolean
Inherited from
Section titled “Inherited from”Tuple3.[unscopables]
0:
boolean
Inherited from
Section titled “Inherited from”Tuple3.0
1:
boolean
Inherited from
Section titled “Inherited from”Tuple3.1
2:
boolean
Inherited from
Section titled “Inherited from”Tuple3.2
readonly
kind:"vec3<bool>"
Defined in: packages/typegpu/src/data/wgslTypes.ts:570
use to distinguish between vectors of the same size on the type level
length
Section titled “length”length:
3
Inherited from
Section titled “Inherited from”Tuple3.length
x:
boolean
Defined in: packages/typegpu/src/data/wgslTypes.ts:571
readonly
xx:v2b
Defined in: packages/typegpu/src/data/wgslTypes.ts:126
Inherited from
Section titled “Inherited from”Swizzle3.xx
readonly
xxx:v3b
Defined in: packages/typegpu/src/data/wgslTypes.ts:131
Inherited from
Section titled “Inherited from”Swizzle3.xxx
readonly
xxxx:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:140
Inherited from
Section titled “Inherited from”Swizzle3.xxxx
readonly
xxxy:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:141
Inherited from
Section titled “Inherited from”Swizzle3.xxxy
readonly
xxxz:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:185
Inherited from
Section titled “Inherited from”Swizzle3.xxxz
readonly
xxy:v3b
Defined in: packages/typegpu/src/data/wgslTypes.ts:132
Inherited from
Section titled “Inherited from”Swizzle3.xxy
readonly
xxyx:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:142
Inherited from
Section titled “Inherited from”Swizzle3.xxyx
readonly
xxyy:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:143
Inherited from
Section titled “Inherited from”Swizzle3.xxyy
readonly
xxyz:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:186
Inherited from
Section titled “Inherited from”Swizzle3.xxyz
readonly
xxz:v3b
Defined in: packages/typegpu/src/data/wgslTypes.ts:165
Inherited from
Section titled “Inherited from”Swizzle3.xxz
readonly
xxzx:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:187
Inherited from
Section titled “Inherited from”Swizzle3.xxzx
readonly
xxzy:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:188
Inherited from
Section titled “Inherited from”Swizzle3.xxzy
readonly
xxzz:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:189
Inherited from
Section titled “Inherited from”Swizzle3.xxzz
readonly
xy:v2b
Defined in: packages/typegpu/src/data/wgslTypes.ts:127
Inherited from
Section titled “Inherited from”Swizzle3.xy
readonly
xyx:v3b
Defined in: packages/typegpu/src/data/wgslTypes.ts:133
Inherited from
Section titled “Inherited from”Swizzle3.xyx
readonly
xyxx:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:144
Inherited from
Section titled “Inherited from”Swizzle3.xyxx
readonly
xyxy:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:145
Inherited from
Section titled “Inherited from”Swizzle3.xyxy
readonly
xyxz:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:190
Inherited from
Section titled “Inherited from”Swizzle3.xyxz
readonly
xyy:v3b
Defined in: packages/typegpu/src/data/wgslTypes.ts:134
Inherited from
Section titled “Inherited from”Swizzle3.xyy
readonly
xyyx:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:146
Inherited from
Section titled “Inherited from”Swizzle3.xyyx
readonly
xyyy:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:147
Inherited from
Section titled “Inherited from”Swizzle3.xyyy
readonly
xyyz:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:191
Inherited from
Section titled “Inherited from”Swizzle3.xyyz
readonly
xyz:v3b
Defined in: packages/typegpu/src/data/wgslTypes.ts:166
Inherited from
Section titled “Inherited from”Swizzle3.xyz
readonly
xyzx:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:192
Inherited from
Section titled “Inherited from”Swizzle3.xyzx
readonly
xyzy:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:193
Inherited from
Section titled “Inherited from”Swizzle3.xyzy
readonly
xyzz:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:194
Inherited from
Section titled “Inherited from”Swizzle3.xyzz
readonly
xz:v2b
Defined in: packages/typegpu/src/data/wgslTypes.ts:159
Inherited from
Section titled “Inherited from”Swizzle3.xz
readonly
xzx:v3b
Defined in: packages/typegpu/src/data/wgslTypes.ts:167
Inherited from
Section titled “Inherited from”Swizzle3.xzx
readonly
xzxx:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:195
Inherited from
Section titled “Inherited from”Swizzle3.xzxx
readonly
xzxy:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:196
Inherited from
Section titled “Inherited from”Swizzle3.xzxy
readonly
xzxz:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:197
Inherited from
Section titled “Inherited from”Swizzle3.xzxz
readonly
xzy:v3b
Defined in: packages/typegpu/src/data/wgslTypes.ts:168
Inherited from
Section titled “Inherited from”Swizzle3.xzy
readonly
xzyx:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:198
Inherited from
Section titled “Inherited from”Swizzle3.xzyx
readonly
xzyy:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:199
Inherited from
Section titled “Inherited from”Swizzle3.xzyy
readonly
xzyz:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:200
Inherited from
Section titled “Inherited from”Swizzle3.xzyz
readonly
xzz:v3b
Defined in: packages/typegpu/src/data/wgslTypes.ts:169
Inherited from
Section titled “Inherited from”Swizzle3.xzz
readonly
xzzx:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:201
Inherited from
Section titled “Inherited from”Swizzle3.xzzx
readonly
xzzy:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:202
Inherited from
Section titled “Inherited from”Swizzle3.xzzy
readonly
xzzz:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:203
Inherited from
Section titled “Inherited from”Swizzle3.xzzz
y:
boolean
Defined in: packages/typegpu/src/data/wgslTypes.ts:572
readonly
yx:v2b
Defined in: packages/typegpu/src/data/wgslTypes.ts:128
Inherited from
Section titled “Inherited from”Swizzle3.yx
readonly
yxx:v3b
Defined in: packages/typegpu/src/data/wgslTypes.ts:135
Inherited from
Section titled “Inherited from”Swizzle3.yxx
readonly
yxxx:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:148
Inherited from
Section titled “Inherited from”Swizzle3.yxxx
readonly
yxxy:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:149
Inherited from
Section titled “Inherited from”Swizzle3.yxxy
readonly
yxxz:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:204
Inherited from
Section titled “Inherited from”Swizzle3.yxxz
readonly
yxy:v3b
Defined in: packages/typegpu/src/data/wgslTypes.ts:136
Inherited from
Section titled “Inherited from”Swizzle3.yxy
readonly
yxyx:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:150
Inherited from
Section titled “Inherited from”Swizzle3.yxyx
readonly
yxyy:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:151
Inherited from
Section titled “Inherited from”Swizzle3.yxyy
readonly
yxyz:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:205
Inherited from
Section titled “Inherited from”Swizzle3.yxyz
readonly
yxz:v3b
Defined in: packages/typegpu/src/data/wgslTypes.ts:170
Inherited from
Section titled “Inherited from”Swizzle3.yxz
readonly
yxzx:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:206
Inherited from
Section titled “Inherited from”Swizzle3.yxzx
readonly
yxzy:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:207
Inherited from
Section titled “Inherited from”Swizzle3.yxzy
readonly
yxzz:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:208
Inherited from
Section titled “Inherited from”Swizzle3.yxzz
readonly
yy:v2b
Defined in: packages/typegpu/src/data/wgslTypes.ts:129
Inherited from
Section titled “Inherited from”Swizzle3.yy
readonly
yyx:v3b
Defined in: packages/typegpu/src/data/wgslTypes.ts:137
Inherited from
Section titled “Inherited from”Swizzle3.yyx
readonly
yyxx:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:152
Inherited from
Section titled “Inherited from”Swizzle3.yyxx
readonly
yyxy:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:153
Inherited from
Section titled “Inherited from”Swizzle3.yyxy
readonly
yyxz:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:209
Inherited from
Section titled “Inherited from”Swizzle3.yyxz
readonly
yyy:v3b
Defined in: packages/typegpu/src/data/wgslTypes.ts:138
Inherited from
Section titled “Inherited from”Swizzle3.yyy
readonly
yyyx:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:154
Inherited from
Section titled “Inherited from”Swizzle3.yyyx
readonly
yyyy:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:155
Inherited from
Section titled “Inherited from”Swizzle3.yyyy
readonly
yyyz:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:210
Inherited from
Section titled “Inherited from”Swizzle3.yyyz
readonly
yyz:v3b
Defined in: packages/typegpu/src/data/wgslTypes.ts:171
Inherited from
Section titled “Inherited from”Swizzle3.yyz
readonly
yyzx:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:211
Inherited from
Section titled “Inherited from”Swizzle3.yyzx
readonly
yyzy:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:212
Inherited from
Section titled “Inherited from”Swizzle3.yyzy
readonly
yyzz:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:213
Inherited from
Section titled “Inherited from”Swizzle3.yyzz
readonly
yz:v2b
Defined in: packages/typegpu/src/data/wgslTypes.ts:160
Inherited from
Section titled “Inherited from”Swizzle3.yz
readonly
yzx:v3b
Defined in: packages/typegpu/src/data/wgslTypes.ts:172
Inherited from
Section titled “Inherited from”Swizzle3.yzx
readonly
yzxx:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:214
Inherited from
Section titled “Inherited from”Swizzle3.yzxx
readonly
yzxy:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:215
Inherited from
Section titled “Inherited from”Swizzle3.yzxy
readonly
yzxz:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:216
Inherited from
Section titled “Inherited from”Swizzle3.yzxz
readonly
yzy:v3b
Defined in: packages/typegpu/src/data/wgslTypes.ts:173
Inherited from
Section titled “Inherited from”Swizzle3.yzy
readonly
yzyx:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:217
Inherited from
Section titled “Inherited from”Swizzle3.yzyx
readonly
yzyy:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:218
Inherited from
Section titled “Inherited from”Swizzle3.yzyy
readonly
yzyz:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:219
Inherited from
Section titled “Inherited from”Swizzle3.yzyz
readonly
yzz:v3b
Defined in: packages/typegpu/src/data/wgslTypes.ts:174
Inherited from
Section titled “Inherited from”Swizzle3.yzz
readonly
yzzx:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:220
Inherited from
Section titled “Inherited from”Swizzle3.yzzx
readonly
yzzy:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:221
Inherited from
Section titled “Inherited from”Swizzle3.yzzy
readonly
yzzz:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:222
Inherited from
Section titled “Inherited from”Swizzle3.yzzz
z:
boolean
Defined in: packages/typegpu/src/data/wgslTypes.ts:573
readonly
zx:v2b
Defined in: packages/typegpu/src/data/wgslTypes.ts:161
Inherited from
Section titled “Inherited from”Swizzle3.zx
readonly
zxx:v3b
Defined in: packages/typegpu/src/data/wgslTypes.ts:175
Inherited from
Section titled “Inherited from”Swizzle3.zxx
readonly
zxxx:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:223
Inherited from
Section titled “Inherited from”Swizzle3.zxxx
readonly
zxxy:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:224
Inherited from
Section titled “Inherited from”Swizzle3.zxxy
readonly
zxxz:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:225
Inherited from
Section titled “Inherited from”Swizzle3.zxxz
readonly
zxy:v3b
Defined in: packages/typegpu/src/data/wgslTypes.ts:176
Inherited from
Section titled “Inherited from”Swizzle3.zxy
readonly
zxyx:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:226
Inherited from
Section titled “Inherited from”Swizzle3.zxyx
readonly
zxyy:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:227
Inherited from
Section titled “Inherited from”Swizzle3.zxyy
readonly
zxyz:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:228
Inherited from
Section titled “Inherited from”Swizzle3.zxyz
readonly
zxz:v3b
Defined in: packages/typegpu/src/data/wgslTypes.ts:177
Inherited from
Section titled “Inherited from”Swizzle3.zxz
readonly
zxzx:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:229
Inherited from
Section titled “Inherited from”Swizzle3.zxzx
readonly
zxzy:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:230
Inherited from
Section titled “Inherited from”Swizzle3.zxzy
readonly
zxzz:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:231
Inherited from
Section titled “Inherited from”Swizzle3.zxzz
readonly
zy:v2b
Defined in: packages/typegpu/src/data/wgslTypes.ts:162
Inherited from
Section titled “Inherited from”Swizzle3.zy
readonly
zyx:v3b
Defined in: packages/typegpu/src/data/wgslTypes.ts:178
Inherited from
Section titled “Inherited from”Swizzle3.zyx
readonly
zyxx:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:232
Inherited from
Section titled “Inherited from”Swizzle3.zyxx
readonly
zyxy:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:233
Inherited from
Section titled “Inherited from”Swizzle3.zyxy
readonly
zyxz:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:234
Inherited from
Section titled “Inherited from”Swizzle3.zyxz
readonly
zyy:v3b
Defined in: packages/typegpu/src/data/wgslTypes.ts:179
Inherited from
Section titled “Inherited from”Swizzle3.zyy
readonly
zyyx:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:235
Inherited from
Section titled “Inherited from”Swizzle3.zyyx
readonly
zyyy:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:236
Inherited from
Section titled “Inherited from”Swizzle3.zyyy
readonly
zyyz:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:237
Inherited from
Section titled “Inherited from”Swizzle3.zyyz
readonly
zyz:v3b
Defined in: packages/typegpu/src/data/wgslTypes.ts:180
Inherited from
Section titled “Inherited from”Swizzle3.zyz
readonly
zyzx:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:238
Inherited from
Section titled “Inherited from”Swizzle3.zyzx
readonly
zyzy:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:239
Inherited from
Section titled “Inherited from”Swizzle3.zyzy
readonly
zyzz:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:240
Inherited from
Section titled “Inherited from”Swizzle3.zyzz
readonly
zz:v2b
Defined in: packages/typegpu/src/data/wgslTypes.ts:163
Inherited from
Section titled “Inherited from”Swizzle3.zz
readonly
zzx:v3b
Defined in: packages/typegpu/src/data/wgslTypes.ts:181
Inherited from
Section titled “Inherited from”Swizzle3.zzx
readonly
zzxx:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:241
Inherited from
Section titled “Inherited from”Swizzle3.zzxx
readonly
zzxy:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:242
Inherited from
Section titled “Inherited from”Swizzle3.zzxy
readonly
zzxz:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:243
Inherited from
Section titled “Inherited from”Swizzle3.zzxz
readonly
zzy:v3b
Defined in: packages/typegpu/src/data/wgslTypes.ts:182
Inherited from
Section titled “Inherited from”Swizzle3.zzy
readonly
zzyx:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:244
Inherited from
Section titled “Inherited from”Swizzle3.zzyx
readonly
zzyy:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:245
Inherited from
Section titled “Inherited from”Swizzle3.zzyy
readonly
zzyz:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:246
Inherited from
Section titled “Inherited from”Swizzle3.zzyz
readonly
zzz:v3b
Defined in: packages/typegpu/src/data/wgslTypes.ts:183
Inherited from
Section titled “Inherited from”Swizzle3.zzz
readonly
zzzx:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:247
Inherited from
Section titled “Inherited from”Swizzle3.zzzx
readonly
zzzy:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:248
Inherited from
Section titled “Inherited from”Swizzle3.zzzy
readonly
zzzz:v4b
Defined in: packages/typegpu/src/data/wgslTypes.ts:249
Inherited from
Section titled “Inherited from”Swizzle3.zzzz
Methods
Section titled “Methods”[iterator]()
Section titled “[iterator]()”[iterator]():
ArrayIterator
<boolean
>
Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.iterable.d.ts:78
Iterator
Returns
Section titled “Returns”ArrayIterator
<boolean
>
Inherited from
Section titled “Inherited from”Tuple3.[iterator]
at(
index
):undefined
|boolean
Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2022.array.d.ts:24
Returns the item located at the specified index.
Parameters
Section titled “Parameters”number
The zero-based index of the desired code unit. A negative index will count back from the last item.
Returns
Section titled “Returns”undefined
| boolean
Inherited from
Section titled “Inherited from”Tuple3.at
concat()
Section titled “concat()”Call Signature
Section titled “Call Signature”concat(…
items
):boolean
[]
Defined in: node_modules/.pnpm/[email protected]/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
Section titled “Parameters”…ConcatArray
<boolean
>[]
Additional arrays and/or items to add to the end of the array.
Returns
Section titled “Returns”boolean
[]
Inherited from
Section titled “Inherited from”Tuple3.concat
Call Signature
Section titled “Call Signature”concat(…
items
):boolean
[]
Defined in: node_modules/.pnpm/[email protected]/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
Section titled “Parameters”…(boolean
| ConcatArray
<boolean
>)[]
Additional arrays and/or items to add to the end of the array.
Returns
Section titled “Returns”boolean
[]
Inherited from
Section titled “Inherited from”Tuple3.concat
copyWithin()
Section titled “copyWithin()”copyWithin(
target
,start
,end
?):this
Defined in: node_modules/.pnpm/[email protected]/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
Section titled “Parameters”target
Section titled “target”number
If target is negative, it is treated as length+target where length is the length of the array.
number
If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
number
If not specified, length of the this object is used as its default value.
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”Tuple3.copyWithin
entries()
Section titled “entries()”entries():
ArrayIterator
<[number
,boolean
]>
Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.iterable.d.ts:83
Returns an iterable of key, value pairs for every entry in the array
Returns
Section titled “Returns”ArrayIterator
<[number
, boolean
]>
Inherited from
Section titled “Inherited from”Tuple3.entries
every()
Section titled “every()”Call Signature
Section titled “Call Signature”every<
S
>(predicate
,thisArg
?):this is S[]
Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1433
Determines whether all the members of an array satisfy the specified test.
Type Parameters
Section titled “Type Parameters”• S extends boolean
Parameters
Section titled “Parameters”predicate
Section titled “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?
Section titled “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
Section titled “Returns”this is S[]
Inherited from
Section titled “Inherited from”Tuple3.every
Call Signature
Section titled “Call Signature”every(
predicate
,thisArg
?):boolean
Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1442
Determines whether all the members of an array satisfy the specified test.
Parameters
Section titled “Parameters”predicate
Section titled “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?
Section titled “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
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”Tuple3.every
fill()
Section titled “fill()”fill(
value
,start
?,end
?):this
Defined in: node_modules/.pnpm/[email protected]/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
Section titled “Parameters”boolean
value to fill array section with
start?
Section titled “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.
number
index to stop filling the array at. If end is negative, it is treated as length+end.
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”Tuple3.fill
filter()
Section titled “filter()”Call Signature
Section titled “Call Signature”filter<
S
>(predicate
,thisArg
?):S
[]
Defined in: node_modules/.pnpm/[email protected]/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
Section titled “Type Parameters”• S extends boolean
Parameters
Section titled “Parameters”predicate
Section titled “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?
Section titled “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
Section titled “Returns”S
[]
Inherited from
Section titled “Inherited from”Tuple3.filter
Call Signature
Section titled “Call Signature”filter(
predicate
,thisArg
?):boolean
[]
Defined in: node_modules/.pnpm/[email protected]/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
Section titled “Parameters”predicate
Section titled “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?
Section titled “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
Section titled “Returns”boolean
[]
Inherited from
Section titled “Inherited from”Tuple3.filter
find()
Section titled “find()”Call Signature
Section titled “Call Signature”find<
S
>(predicate
,thisArg
?):undefined
|S
Defined in: node_modules/.pnpm/[email protected]/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
Section titled “Type Parameters”• S extends boolean
Parameters
Section titled “Parameters”predicate
Section titled “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?
Section titled “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
Section titled “Returns”undefined
| S
Inherited from
Section titled “Inherited from”Tuple3.find
Call Signature
Section titled “Call Signature”find(
predicate
,thisArg
?):undefined
|boolean
Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.core.d.ts:30
Parameters
Section titled “Parameters”predicate
Section titled “predicate”(value
, index
, obj
) => unknown
thisArg?
Section titled “thisArg?”any
Returns
Section titled “Returns”undefined
| boolean
Inherited from
Section titled “Inherited from”Tuple3.find
findIndex()
Section titled “findIndex()”findIndex(
predicate
,thisArg
?):number
Defined in: node_modules/.pnpm/[email protected]/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
Section titled “Parameters”predicate
Section titled “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?
Section titled “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
Section titled “Returns”number
Inherited from
Section titled “Inherited from”Tuple3.findIndex
findLast()
Section titled “findLast()”Call Signature
Section titled “Call Signature”findLast<
S
>(predicate
,thisArg
?):undefined
|S
Defined in: node_modules/.pnpm/[email protected]/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
Section titled “Type Parameters”• S extends boolean
Parameters
Section titled “Parameters”predicate
Section titled “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?
Section titled “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
Section titled “Returns”undefined
| S
Inherited from
Section titled “Inherited from”Tuple3.findLast
Call Signature
Section titled “Call Signature”findLast(
predicate
,thisArg
?):undefined
|boolean
Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2023.array.d.ts:30
Parameters
Section titled “Parameters”predicate
Section titled “predicate”(value
, index
, array
) => unknown
thisArg?
Section titled “thisArg?”any
Returns
Section titled “Returns”undefined
| boolean
Inherited from
Section titled “Inherited from”Tuple3.findLast
findLastIndex()
Section titled “findLastIndex()”findLastIndex(
predicate
,thisArg
?):number
Defined in: node_modules/.pnpm/[email protected]/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
Section titled “Parameters”predicate
Section titled “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?
Section titled “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
Section titled “Returns”number
Inherited from
Section titled “Inherited from”Tuple3.findLastIndex
flat()
Section titled “flat()”flat<
A
,D
>(this
,depth
?):FlatArray
<A
,D
>[]
Defined in: node_modules/.pnpm/[email protected]/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
Section titled “Type Parameters”• A
• D extends number
= 1
Parameters
Section titled “Parameters”A
depth?
Section titled “depth?”D
The maximum recursion depth
Returns
Section titled “Returns”FlatArray
<A
, D
>[]
Inherited from
Section titled “Inherited from”Tuple3.flat
flatMap()
Section titled “flatMap()”flatMap<
U
,This
>(callback
,thisArg
?):U
[]
Defined in: node_modules/.pnpm/[email protected]/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
Section titled “Type Parameters”• U
• This = undefined
Parameters
Section titled “Parameters”callback
Section titled “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?
Section titled “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
Section titled “Returns”U
[]
Inherited from
Section titled “Inherited from”Tuple3.flatMap
forEach()
Section titled “forEach()”forEach(
callbackfn
,thisArg
?):void
Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1457
Performs the specified action for each element in an array.
Parameters
Section titled “Parameters”callbackfn
Section titled “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?
Section titled “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
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Tuple3.forEach
includes()
Section titled “includes()”includes(
searchElement
,fromIndex
?):boolean
Defined in: node_modules/.pnpm/[email protected]/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
Section titled “Parameters”searchElement
Section titled “searchElement”boolean
The element to search for.
fromIndex?
Section titled “fromIndex?”number
The position in this array at which to begin searching for searchElement.
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”Tuple3.includes
indexOf()
Section titled “indexOf()”indexOf(
searchElement
,fromIndex
?):number
Defined in: node_modules/.pnpm/[email protected]/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
Section titled “Parameters”searchElement
Section titled “searchElement”boolean
The value to locate in the array.
fromIndex?
Section titled “fromIndex?”number
The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”Tuple3.indexOf
join()
Section titled “join()”join(
separator
?):string
Defined in: node_modules/.pnpm/[email protected]/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
Section titled “Parameters”separator?
Section titled “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
Section titled “Returns”string
Inherited from
Section titled “Inherited from”Tuple3.join
keys()
Section titled “keys()”keys():
ArrayIterator
<number
>
Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.iterable.d.ts:88
Returns an iterable of keys in the array
Returns
Section titled “Returns”ArrayIterator
<number
>
Inherited from
Section titled “Inherited from”Tuple3.keys
lastIndexOf()
Section titled “lastIndexOf()”lastIndexOf(
searchElement
,fromIndex
?):number
Defined in: node_modules/.pnpm/[email protected]/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
Section titled “Parameters”searchElement
Section titled “searchElement”boolean
The value to locate in the array.
fromIndex?
Section titled “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
Section titled “Returns”number
Inherited from
Section titled “Inherited from”Tuple3.lastIndexOf
map<
U
>(callbackfn
,thisArg
?):U
[]
Defined in: node_modules/.pnpm/[email protected]/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
Section titled “Type Parameters”• U
Parameters
Section titled “Parameters”callbackfn
Section titled “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?
Section titled “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
Section titled “Returns”U
[]
Inherited from
Section titled “Inherited from”Tuple3.map
pop():
undefined
|boolean
Defined in: node_modules/.pnpm/[email protected]/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
Section titled “Returns”undefined
| boolean
Inherited from
Section titled “Inherited from”Tuple3.pop
push()
Section titled “push()”push(…
items
):number
Defined in: node_modules/.pnpm/[email protected]/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
Section titled “Parameters”…boolean
[]
New elements to add to the array.
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”Tuple3.push
reduce()
Section titled “reduce()”Call Signature
Section titled “Call Signature”reduce(
callbackfn
):boolean
Defined in: node_modules/.pnpm/[email protected]/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
Section titled “Parameters”callbackfn
Section titled “callbackfn”(previousValue
, currentValue
, currentIndex
, array
) => boolean
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”Tuple3.reduce
Call Signature
Section titled “Call Signature”reduce(
callbackfn
,initialValue
):boolean
Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1482
Parameters
Section titled “Parameters”callbackfn
Section titled “callbackfn”(previousValue
, currentValue
, currentIndex
, array
) => boolean
initialValue
Section titled “initialValue”boolean
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”Tuple3.reduce
Call Signature
Section titled “Call Signature”reduce<
U
>(callbackfn
,initialValue
):U
Defined in: node_modules/.pnpm/[email protected]/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
Section titled “Type Parameters”• U
Parameters
Section titled “Parameters”callbackfn
Section titled “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
Section titled “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
Section titled “Returns”U
Inherited from
Section titled “Inherited from”Tuple3.reduce
reduceRight()
Section titled “reduceRight()”Call Signature
Section titled “Call Signature”reduceRight(
callbackfn
):boolean
Defined in: node_modules/.pnpm/[email protected]/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
Section titled “Parameters”callbackfn
Section titled “callbackfn”(previousValue
, currentValue
, currentIndex
, array
) => boolean
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”Tuple3.reduceRight
Call Signature
Section titled “Call Signature”reduceRight(
callbackfn
,initialValue
):boolean
Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1495
Parameters
Section titled “Parameters”callbackfn
Section titled “callbackfn”(previousValue
, currentValue
, currentIndex
, array
) => boolean
initialValue
Section titled “initialValue”boolean
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”Tuple3.reduceRight
Call Signature
Section titled “Call Signature”reduceRight<
U
>(callbackfn
,initialValue
):U
Defined in: node_modules/.pnpm/[email protected]/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
Section titled “Type Parameters”• U
Parameters
Section titled “Parameters”callbackfn
Section titled “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
Section titled “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
Section titled “Returns”U
Inherited from
Section titled “Inherited from”Tuple3.reduceRight
reverse()
Section titled “reverse()”reverse():
boolean
[]
Defined in: node_modules/.pnpm/[email protected]/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
Section titled “Returns”boolean
[]
Inherited from
Section titled “Inherited from”Tuple3.reverse
shift()
Section titled “shift()”shift():
undefined
|boolean
Defined in: node_modules/.pnpm/[email protected]/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
Section titled “Returns”undefined
| boolean
Inherited from
Section titled “Inherited from”Tuple3.shift
slice()
Section titled “slice()”slice(
start
?,end
?):boolean
[]
Defined in: node_modules/.pnpm/[email protected]/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
Section titled “Parameters”start?
Section titled “start?”number
The beginning index of the specified portion of the array. If start is undefined, then the slice begins at index 0.
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
Section titled “Returns”boolean
[]
Inherited from
Section titled “Inherited from”Tuple3.slice
some()
Section titled “some()”some(
predicate
,thisArg
?):boolean
Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1451
Determines whether the specified callback function returns true for any element of an array.
Parameters
Section titled “Parameters”predicate
Section titled “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?
Section titled “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
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”Tuple3.some
sort()
Section titled “sort()”sort(
compareFn
?):this
Defined in: node_modules/.pnpm/[email protected]/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
Section titled “Parameters”compareFn?
Section titled “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
Section titled “Returns”this
Inherited from
Section titled “Inherited from”Tuple3.sort
splice()
Section titled “splice()”Call Signature
Section titled “Call Signature”splice(
start
,deleteCount
?):boolean
[]
Defined in: node_modules/.pnpm/[email protected]/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
Section titled “Parameters”number
The zero-based location in the array from which to start removing elements.
deleteCount?
Section titled “deleteCount?”number
The number of elements to remove.
Returns
Section titled “Returns”boolean
[]
An array containing the elements that were deleted.
Inherited from
Section titled “Inherited from”Tuple3.splice
Call Signature
Section titled “Call Signature”splice(
start
,deleteCount
, …items
):boolean
[]
Defined in: node_modules/.pnpm/[email protected]/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
Section titled “Parameters”number
The zero-based location in the array from which to start removing elements.
deleteCount
Section titled “deleteCount”number
The number of elements to remove.
…boolean
[]
Elements to insert into the array in place of the deleted elements.
Returns
Section titled “Returns”boolean
[]
An array containing the elements that were deleted.
Inherited from
Section titled “Inherited from”Tuple3.splice
toLocaleString()
Section titled “toLocaleString()”Call Signature
Section titled “Call Signature”toLocaleString():
string
Defined in: node_modules/.pnpm/[email protected]/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
Section titled “Returns”string
Inherited from
Section titled “Inherited from”Tuple3.toLocaleString
Call Signature
Section titled “Call Signature”toLocaleString(
locales
,options
?):string
Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Parameters
Section titled “Parameters”locales
Section titled “locales”string
| string
[]
options?
Section titled “options?”NumberFormatOptions
& DateTimeFormatOptions
Returns
Section titled “Returns”string
Inherited from
Section titled “Inherited from”Tuple3.toLocaleString
toReversed()
Section titled “toReversed()”toReversed():
boolean
[]
Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2023.array.d.ts:46
Returns a copy of an array with its elements reversed.
Returns
Section titled “Returns”boolean
[]
Inherited from
Section titled “Inherited from”Tuple3.toReversed
toSorted()
Section titled “toSorted()”toSorted(
compareFn
?):boolean
[]
Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2023.array.d.ts:57
Returns a copy of an array with its elements sorted.
Parameters
Section titled “Parameters”compareFn?
Section titled “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
Section titled “Returns”boolean
[]
Inherited from
Section titled “Inherited from”Tuple3.toSorted
toSpliced()
Section titled “toSpliced()”Call Signature
Section titled “Call Signature”toSpliced(
start
,deleteCount
, …items
):boolean
[]
Defined in: node_modules/.pnpm/[email protected]/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
Section titled “Parameters”number
The zero-based location in the array from which to start removing elements.
deleteCount
Section titled “deleteCount”number
The number of elements to remove.
…boolean
[]
Elements to insert into the copied array in place of the deleted elements.
Returns
Section titled “Returns”boolean
[]
The copied array.
Inherited from
Section titled “Inherited from”Tuple3.toSpliced
Call Signature
Section titled “Call Signature”toSpliced(
start
,deleteCount
?):boolean
[]
Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2023.array.d.ts:74
Copies an array and removes elements while returning the remaining elements.
Parameters
Section titled “Parameters”number
The zero-based location in the array from which to start removing elements.
deleteCount?
Section titled “deleteCount?”number
The number of elements to remove.
Returns
Section titled “Returns”boolean
[]
A copy of the original array with the remaining elements.
Inherited from
Section titled “Inherited from”Tuple3.toSpliced
toString()
Section titled “toString()”toString():
string
Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1330
Returns a string representation of an array.
Returns
Section titled “Returns”string
Inherited from
Section titled “Inherited from”Tuple3.toString
unshift()
Section titled “unshift()”unshift(…
items
):number
Defined in: node_modules/.pnpm/[email protected]/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
Section titled “Parameters”…boolean
[]
Elements to insert at the start of the array.
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”Tuple3.unshift
values()
Section titled “values()”values():
ArrayIterator
<boolean
>
Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.iterable.d.ts:93
Returns an iterable of values in the array
Returns
Section titled “Returns”ArrayIterator
<boolean
>
Inherited from
Section titled “Inherited from”Tuple3.values
with()
Section titled “with()”with(
index
,value
):boolean
[]
Defined in: node_modules/.pnpm/[email protected]/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
Section titled “Parameters”number
The index of the value to overwrite. If the index is negative, then it replaces from the end of the array.
boolean
The value to write into the copied array.
Returns
Section titled “Returns”boolean
[]
The copied array with the updated value.
Inherited from
Section titled “Inherited from”Tuple3.with