v3b

Defined in: packages/typegpu/src/data/wgslTypes.ts:569

Interface representing its WGSL vector type counterpart: vec3<bool>. A vector with 3 elements of type bool

Extends

• Tuple3<boolean>.Swizzle3<v2b, v3b, v4b>

Indexable

[n: number]: boolean

Properties

[$internal]

readonly [$internal]: true

Defined in: packages/typegpu/src/data/wgslTypes.ts:570

---

[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

[key: number]: undefined | boolean

[iterator]?

optional [iterator]: boolean

[unscopables]?

readonly optional [unscopables]: boolean

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

at?

optional at: boolean

concat?

optional concat: boolean

copyWithin?

optional copyWithin: boolean

entries?

optional entries: boolean

every?

optional every: boolean

fill?

optional fill: boolean

filter?

optional filter: boolean

find?

optional find: boolean

findIndex?

optional findIndex: boolean

findLast?

optional findLast: boolean

findLastIndex?

optional findLastIndex: boolean

flat?

optional flat: boolean

flatMap?

optional flatMap: boolean

forEach?

optional forEach: boolean

includes?

optional includes: boolean

indexOf?

optional indexOf: boolean

join?

optional join: boolean

keys?

optional keys: boolean

lastIndexOf?

optional lastIndexOf: boolean

length?

optional length: boolean

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

map?

optional map: boolean

pop?

optional pop: boolean

push?

optional push: boolean

reduce?

optional reduce: boolean

reduceRight?

optional reduceRight: boolean

reverse?

optional reverse: boolean

shift?

optional shift: boolean

slice?

optional slice: boolean

some?

optional some: boolean

sort?

optional sort: boolean

splice?

optional splice: boolean

toLocaleString?

optional toLocaleString: boolean

toReversed?

optional toReversed: boolean

toSorted?

optional toSorted: boolean

toSpliced?

optional toSpliced: boolean

toString?

optional toString: boolean

unshift?

optional unshift: boolean

values?

optional values: boolean

with?

optional with: boolean

Inherited from

Tuple3.[unscopables]

---

0

0: boolean

Inherited from

Tuple3.0

---

1

1: boolean

Inherited from

Tuple3.1

---

2

2: boolean

Inherited from

Tuple3.2

---

kind

readonly kind: "vec3<bool>"

Defined in: packages/typegpu/src/data/wgslTypes.ts:572

use to distinguish between vectors of the same size on the type level

---

length

length: 3

Inherited from

Tuple3.length

---

x

x: boolean

Defined in: packages/typegpu/src/data/wgslTypes.ts:573

---

xx

readonly xx: v2b

Defined in: packages/typegpu/src/data/wgslTypes.ts:128

Inherited from

Swizzle3.xx

---

xxx

readonly xxx: v3b

Defined in: packages/typegpu/src/data/wgslTypes.ts:133

Inherited from

Swizzle3.xxx

---

xxxx

readonly xxxx: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:142

Inherited from

Swizzle3.xxxx

---

xxxy

readonly xxxy: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:143

Inherited from

Swizzle3.xxxy

---

xxxz

readonly xxxz: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:187

Inherited from

Swizzle3.xxxz

---

xxy

readonly xxy: v3b

Defined in: packages/typegpu/src/data/wgslTypes.ts:134

Inherited from

Swizzle3.xxy

---

xxyx

readonly xxyx: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:144

Inherited from

Swizzle3.xxyx

---

xxyy

readonly xxyy: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:145

Inherited from

Swizzle3.xxyy

---

xxyz

readonly xxyz: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:188

Inherited from

Swizzle3.xxyz

---

xxz

readonly xxz: v3b

Defined in: packages/typegpu/src/data/wgslTypes.ts:167

Inherited from

Swizzle3.xxz

---

xxzx

readonly xxzx: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:189

Inherited from

Swizzle3.xxzx

---

xxzy

readonly xxzy: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:190

Inherited from

Swizzle3.xxzy

---

xxzz

readonly xxzz: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:191

Inherited from

Swizzle3.xxzz

---

xy

readonly xy: v2b

Defined in: packages/typegpu/src/data/wgslTypes.ts:129

Inherited from

Swizzle3.xy

---

xyx

readonly xyx: v3b

Defined in: packages/typegpu/src/data/wgslTypes.ts:135

Inherited from

Swizzle3.xyx

---

xyxx

readonly xyxx: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:146

Inherited from

Swizzle3.xyxx

---

xyxy

readonly xyxy: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:147

Inherited from

Swizzle3.xyxy

---

xyxz

readonly xyxz: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:192

Inherited from

Swizzle3.xyxz

---

xyy

readonly xyy: v3b

Defined in: packages/typegpu/src/data/wgslTypes.ts:136

Inherited from

Swizzle3.xyy

---

xyyx

readonly xyyx: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:148

Inherited from

Swizzle3.xyyx

---

xyyy

readonly xyyy: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:149

Inherited from

Swizzle3.xyyy

---

xyyz

readonly xyyz: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:193

Inherited from

Swizzle3.xyyz

---

xyz

readonly xyz: v3b

Defined in: packages/typegpu/src/data/wgslTypes.ts:168

Inherited from

Swizzle3.xyz

---

xyzx

readonly xyzx: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:194

Inherited from

Swizzle3.xyzx

---

xyzy

readonly xyzy: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:195

Inherited from

Swizzle3.xyzy

---

xyzz

readonly xyzz: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:196

Inherited from

Swizzle3.xyzz

---

xz

readonly xz: v2b

Defined in: packages/typegpu/src/data/wgslTypes.ts:161

Inherited from

Swizzle3.xz

---

xzx

readonly xzx: v3b

Defined in: packages/typegpu/src/data/wgslTypes.ts:169

Inherited from

Swizzle3.xzx

---

xzxx

readonly xzxx: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:197

Inherited from

Swizzle3.xzxx

---

xzxy

readonly xzxy: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:198

Inherited from

Swizzle3.xzxy

---

xzxz

readonly xzxz: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:199

Inherited from

Swizzle3.xzxz

---

xzy

readonly xzy: v3b

Defined in: packages/typegpu/src/data/wgslTypes.ts:170

Inherited from

Swizzle3.xzy

---

xzyx

readonly xzyx: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:200

Inherited from

Swizzle3.xzyx

---

xzyy

readonly xzyy: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:201

Inherited from

Swizzle3.xzyy

---

xzyz

readonly xzyz: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:202

Inherited from

Swizzle3.xzyz

---

xzz

readonly xzz: v3b

Defined in: packages/typegpu/src/data/wgslTypes.ts:171

Inherited from

Swizzle3.xzz

---

xzzx

readonly xzzx: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:203

Inherited from

Swizzle3.xzzx

---

xzzy

readonly xzzy: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:204

Inherited from

Swizzle3.xzzy

---

xzzz

readonly xzzz: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:205

Inherited from

Swizzle3.xzzz

---

y

y: boolean

Defined in: packages/typegpu/src/data/wgslTypes.ts:574

---

yx

readonly yx: v2b

Defined in: packages/typegpu/src/data/wgslTypes.ts:130

Inherited from

Swizzle3.yx

---

yxx

readonly yxx: v3b

Defined in: packages/typegpu/src/data/wgslTypes.ts:137

Inherited from

Swizzle3.yxx

---

yxxx

readonly yxxx: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:150

Inherited from

Swizzle3.yxxx

---

yxxy

readonly yxxy: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:151

Inherited from

Swizzle3.yxxy

---

yxxz

readonly yxxz: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:206

Inherited from

Swizzle3.yxxz

---

yxy

readonly yxy: v3b

Defined in: packages/typegpu/src/data/wgslTypes.ts:138

Inherited from

Swizzle3.yxy

---

yxyx

readonly yxyx: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:152

Inherited from

Swizzle3.yxyx

---

yxyy

readonly yxyy: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:153

Inherited from

Swizzle3.yxyy

---

yxyz

readonly yxyz: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:207

Inherited from

Swizzle3.yxyz

---

yxz

readonly yxz: v3b

Defined in: packages/typegpu/src/data/wgslTypes.ts:172

Inherited from

Swizzle3.yxz

---

yxzx

readonly yxzx: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:208

Inherited from

Swizzle3.yxzx

---

yxzy

readonly yxzy: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:209

Inherited from

Swizzle3.yxzy

---

yxzz

readonly yxzz: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:210

Inherited from

Swizzle3.yxzz

---

yy

readonly yy: v2b

Defined in: packages/typegpu/src/data/wgslTypes.ts:131

Inherited from

Swizzle3.yy

---

yyx

readonly yyx: v3b

Defined in: packages/typegpu/src/data/wgslTypes.ts:139

Inherited from

Swizzle3.yyx

---

yyxx

readonly yyxx: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:154

Inherited from

Swizzle3.yyxx

---

yyxy

readonly yyxy: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:155

Inherited from

Swizzle3.yyxy

---

yyxz

readonly yyxz: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:211

Inherited from

Swizzle3.yyxz

---

yyy

readonly yyy: v3b

Defined in: packages/typegpu/src/data/wgslTypes.ts:140

Inherited from

Swizzle3.yyy

---

yyyx

readonly yyyx: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:156

Inherited from

Swizzle3.yyyx

---

yyyy

readonly yyyy: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:157

Inherited from

Swizzle3.yyyy

---

yyyz

readonly yyyz: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:212

Inherited from

Swizzle3.yyyz

---

yyz

readonly yyz: v3b

Defined in: packages/typegpu/src/data/wgslTypes.ts:173

Inherited from

Swizzle3.yyz

---

yyzx

readonly yyzx: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:213

Inherited from

Swizzle3.yyzx

---

yyzy

readonly yyzy: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:214

Inherited from

Swizzle3.yyzy

---

yyzz

readonly yyzz: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:215

Inherited from

Swizzle3.yyzz

---

yz

readonly yz: v2b

Defined in: packages/typegpu/src/data/wgslTypes.ts:162

Inherited from

Swizzle3.yz

---

yzx

readonly yzx: v3b

Defined in: packages/typegpu/src/data/wgslTypes.ts:174

Inherited from

Swizzle3.yzx

---

yzxx

readonly yzxx: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:216

Inherited from

Swizzle3.yzxx

---

yzxy

readonly yzxy: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:217

Inherited from

Swizzle3.yzxy

---

yzxz

readonly yzxz: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:218

Inherited from

Swizzle3.yzxz

---

yzy

readonly yzy: v3b

Defined in: packages/typegpu/src/data/wgslTypes.ts:175

Inherited from

Swizzle3.yzy

---

yzyx

readonly yzyx: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:219

Inherited from

Swizzle3.yzyx

---

yzyy

readonly yzyy: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:220

Inherited from

Swizzle3.yzyy

---

yzyz

readonly yzyz: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:221

Inherited from

Swizzle3.yzyz

---

yzz

readonly yzz: v3b

Defined in: packages/typegpu/src/data/wgslTypes.ts:176

Inherited from

Swizzle3.yzz

---

yzzx

readonly yzzx: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:222

Inherited from

Swizzle3.yzzx

---

yzzy

readonly yzzy: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:223

Inherited from

Swizzle3.yzzy

---

yzzz

readonly yzzz: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:224

Inherited from

Swizzle3.yzzz

---

z

z: boolean

Defined in: packages/typegpu/src/data/wgslTypes.ts:575

---

zx

readonly zx: v2b

Defined in: packages/typegpu/src/data/wgslTypes.ts:163

Inherited from

Swizzle3.zx

---

zxx

readonly zxx: v3b

Defined in: packages/typegpu/src/data/wgslTypes.ts:177

Inherited from

Swizzle3.zxx

---

zxxx

readonly zxxx: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:225

Inherited from

Swizzle3.zxxx

---

zxxy

readonly zxxy: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:226

Inherited from

Swizzle3.zxxy

---

zxxz

readonly zxxz: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:227

Inherited from

Swizzle3.zxxz

---

zxy

readonly zxy: v3b

Defined in: packages/typegpu/src/data/wgslTypes.ts:178

Inherited from

Swizzle3.zxy

---

zxyx

readonly zxyx: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:228

Inherited from

Swizzle3.zxyx

---

zxyy

readonly zxyy: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:229

Inherited from

Swizzle3.zxyy

---

zxyz

readonly zxyz: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:230

Inherited from

Swizzle3.zxyz

---

zxz

readonly zxz: v3b

Defined in: packages/typegpu/src/data/wgslTypes.ts:179

Inherited from

Swizzle3.zxz

---

zxzx

readonly zxzx: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:231

Inherited from

Swizzle3.zxzx

---

zxzy

readonly zxzy: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:232

Inherited from

Swizzle3.zxzy

---

zxzz

readonly zxzz: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:233

Inherited from

Swizzle3.zxzz

---

zy

readonly zy: v2b

Defined in: packages/typegpu/src/data/wgslTypes.ts:164

Inherited from

Swizzle3.zy

---

zyx

readonly zyx: v3b

Defined in: packages/typegpu/src/data/wgslTypes.ts:180

Inherited from

Swizzle3.zyx

---

zyxx

readonly zyxx: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:234

Inherited from

Swizzle3.zyxx

---

zyxy

readonly zyxy: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:235

Inherited from

Swizzle3.zyxy

---

zyxz

readonly zyxz: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:236

Inherited from

Swizzle3.zyxz

---

zyy

readonly zyy: v3b

Defined in: packages/typegpu/src/data/wgslTypes.ts:181

Inherited from

Swizzle3.zyy

---

zyyx

readonly zyyx: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:237

Inherited from

Swizzle3.zyyx

---

zyyy

readonly zyyy: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:238

Inherited from

Swizzle3.zyyy

---

zyyz

readonly zyyz: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:239

Inherited from

Swizzle3.zyyz

---

zyz

readonly zyz: v3b

Defined in: packages/typegpu/src/data/wgslTypes.ts:182

Inherited from

Swizzle3.zyz

---

zyzx

readonly zyzx: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:240

Inherited from

Swizzle3.zyzx

---

zyzy

readonly zyzy: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:241

Inherited from

Swizzle3.zyzy

---

zyzz

readonly zyzz: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:242

Inherited from

Swizzle3.zyzz

---

zz

readonly zz: v2b

Defined in: packages/typegpu/src/data/wgslTypes.ts:165

Inherited from

Swizzle3.zz

---

zzx

readonly zzx: v3b

Defined in: packages/typegpu/src/data/wgslTypes.ts:183

Inherited from

Swizzle3.zzx

---

zzxx

readonly zzxx: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:243

Inherited from

Swizzle3.zzxx

---

zzxy

readonly zzxy: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:244

Inherited from

Swizzle3.zzxy

---

zzxz

readonly zzxz: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:245

Inherited from

Swizzle3.zzxz

---

zzy

readonly zzy: v3b

Defined in: packages/typegpu/src/data/wgslTypes.ts:184

Inherited from

Swizzle3.zzy

---

zzyx

readonly zzyx: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:246

Inherited from

Swizzle3.zzyx

---

zzyy

readonly zzyy: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:247

Inherited from

Swizzle3.zzyy

---

zzyz

readonly zzyz: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:248

Inherited from

Swizzle3.zzyz

---

zzz

readonly zzz: v3b

Defined in: packages/typegpu/src/data/wgslTypes.ts:185

Inherited from

Swizzle3.zzz

---

zzzx

readonly zzzx: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:249

Inherited from

Swizzle3.zzzx

---

zzzy

readonly zzzy: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:250

Inherited from

Swizzle3.zzzy

---

zzzz

readonly zzzz: v4b

Defined in: packages/typegpu/src/data/wgslTypes.ts:251

Inherited from

Swizzle3.zzzz

Methods

[iterator]()

[iterator](): ArrayIterator<boolean>

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.iterable.d.ts:78

Iterator

Returns

ArrayIterator<boolean>

Inherited from

Tuple3.[iterator]

---

at()

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

index

number

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

Returns

undefined | boolean

Inherited from

Tuple3.at

---

concat()

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

items

…ConcatArray<boolean>[]

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

Returns

boolean[]

Inherited from

Tuple3.concat

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

items

…(boolean | ConcatArray<boolean>)[]

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

Returns

boolean[]

Inherited from

Tuple3.concat

---

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

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

Tuple3.copyWithin

---

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

ArrayIterator<[number, boolean]>

Inherited from

Tuple3.entries

---

every()

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

• S extends boolean

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

Tuple3.every

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

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

Tuple3.every

---

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

value

boolean

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

Tuple3.fill

---

filter()

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

• S extends boolean

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

Tuple3.filter

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

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

boolean[]

Inherited from

Tuple3.filter

---

find()

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

• S extends boolean

Parameters

predicate

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

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

thisArg?

any

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

Returns

undefined | S

Inherited from

Tuple3.find

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

predicate

(value, index, obj) => unknown

thisArg?

any

Returns

undefined | boolean

Inherited from

Tuple3.find

---

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

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

Tuple3.findIndex

---

findLast()

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

• S extends boolean

Parameters

predicate

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

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

thisArg?

any

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

Returns

undefined | S

Inherited from

Tuple3.findLast

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

predicate

(value, index, array) => unknown

thisArg?

any

Returns

undefined | boolean

Inherited from

Tuple3.findLast

---

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

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

Tuple3.findLastIndex

---

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

• A

• D extends number = 1

Parameters

this

A

depth?

D

The maximum recursion depth

Returns

FlatArray<A, D>[]

Inherited from

Tuple3.flat

---

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

• U

• 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

Tuple3.flatMap

---

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

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

Tuple3.forEach

---

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

searchElement

boolean

The element to search for.

fromIndex?

number

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

Returns

boolean

Inherited from

Tuple3.includes

---

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

searchElement

boolean

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

Tuple3.indexOf

---

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

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

Tuple3.join

---

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

ArrayIterator<number>

Inherited from

Tuple3.keys

---

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

searchElement

boolean

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

Tuple3.lastIndexOf

---

map()

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

• 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

Tuple3.map

---

pop()

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

undefined | boolean

Inherited from

Tuple3.pop

---

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

items

…boolean[]

New elements to add to the array.

Returns

number

Inherited from

Tuple3.push

---

reduce()

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

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

boolean

Inherited from

Tuple3.reduce

Call Signature

reduce(callbackfn, initialValue): boolean

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1482

Parameters

callbackfn

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

initialValue

boolean

Returns

boolean

Inherited from

Tuple3.reduce

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

• 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

Tuple3.reduce

---

reduceRight()

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

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

boolean

Inherited from

Tuple3.reduceRight

Call Signature

reduceRight(callbackfn, initialValue): boolean

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1495

Parameters

callbackfn

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

initialValue

boolean

Returns

boolean

Inherited from

Tuple3.reduceRight

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

• 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

Tuple3.reduceRight

---

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

boolean[]

Inherited from

Tuple3.reverse

---

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

undefined | boolean

Inherited from

Tuple3.shift

---

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

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

boolean[]

Inherited from

Tuple3.slice

---

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

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

Tuple3.some

---

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

compareFn?

(a, b) => number

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

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

Returns

this

Inherited from

Tuple3.sort

---

splice()

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

start

number

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

deleteCount?

number

The number of elements to remove.

Returns

boolean[]

An array containing the elements that were deleted.

Inherited from

Tuple3.splice

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

start

number

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

deleteCount

number

The number of elements to remove.

items

…boolean[]

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

Returns

boolean[]

An array containing the elements that were deleted.

Inherited from

Tuple3.splice

---

toLocaleString()

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

string

Inherited from

Tuple3.toLocaleString

Call Signature

toLocaleString(locales, options?): string

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2015.core.d.ts:64

Parameters

locales

string | string[]

options?

NumberFormatOptions & DateTimeFormatOptions

Returns

string

Inherited from

Tuple3.toLocaleString

---

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

boolean[]

Inherited from

Tuple3.toReversed

---

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

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

boolean[]

Inherited from

Tuple3.toSorted

---

toSpliced()

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

start

number

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

deleteCount

number

The number of elements to remove.

items

…boolean[]

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

Returns

boolean[]

The copied array.

Inherited from

Tuple3.toSpliced

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

start

number

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

deleteCount?

number

The number of elements to remove.

Returns

boolean[]

A copy of the original array with the remaining elements.

Inherited from

Tuple3.toSpliced

---

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

string

Inherited from

Tuple3.toString

---

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

items

…boolean[]

Elements to insert at the start of the array.

Returns

number

Inherited from

Tuple3.unshift

---

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

ArrayIterator<boolean>

Inherited from

Tuple3.values

---

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

index

number

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

value

boolean

The value to write into the copied array.

Returns

boolean[]

The copied array with the updated value.

Inherited from

Tuple3.with