v3b

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:338

---

[unscopables]

readonly [unscopables]: object

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

Index Signature

[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]

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es2015.symbol.wellknown.d.ts:97

---

0

0: boolean

Inherited from

Tuple3.0

---

1

1: boolean

Inherited from

Tuple3.1

---

2

2: boolean

Inherited from

Tuple3.2

---

b

b: boolean

Defined in

packages/typegpu/src/data/wgslTypes.ts:346

---

bb

bb: v2b

Inherited from

Swizzle3.bb

---

bbb

bbb: v3b

Inherited from

Swizzle3.bbb

---

bbbb

bbbb: v4b

Inherited from

Swizzle3.bbbb

---

bbbg

bbbg: v4b

Inherited from

Swizzle3.bbbg

---

bbbr

bbbr: v4b

Inherited from

Swizzle3.bbbr

---

bbg

bbg: v3b

Inherited from

Swizzle3.bbg

---

bbgb

bbgb: v4b

Inherited from

Swizzle3.bbgb

---

bbgg

bbgg: v4b

Inherited from

Swizzle3.bbgg

---

bbgr

bbgr: v4b

Inherited from

Swizzle3.bbgr

---

bbr

bbr: v3b

Inherited from

Swizzle3.bbr

---

bbrb

bbrb: v4b

Inherited from

Swizzle3.bbrb

---

bbrg

bbrg: v4b

Inherited from

Swizzle3.bbrg

---

bbrr

bbrr: v4b

Inherited from

Swizzle3.bbrr

---

bg

bg: v2b

Inherited from

Swizzle3.bg

---

bgb

bgb: v3b

Inherited from

Swizzle3.bgb

---

bgbb

bgbb: v4b

Inherited from

Swizzle3.bgbb

---

bgbg

bgbg: v4b

Inherited from

Swizzle3.bgbg

---

bgbr

bgbr: v4b

Inherited from

Swizzle3.bgbr

---

bgg

bgg: v3b

Inherited from

Swizzle3.bgg

---

bggb

bggb: v4b

Inherited from

Swizzle3.bggb

---

bggg

bggg: v4b

Inherited from

Swizzle3.bggg

---

bggr

bggr: v4b

Inherited from

Swizzle3.bggr

---

bgr

bgr: v3b

Inherited from

Swizzle3.bgr

---

bgrb

bgrb: v4b

Inherited from

Swizzle3.bgrb

---

bgrg

bgrg: v4b

Inherited from

Swizzle3.bgrg

---

bgrr

bgrr: v4b

Inherited from

Swizzle3.bgrr

---

br

br: v2b

Inherited from

Swizzle3.br

---

brb

brb: v3b

Inherited from

Swizzle3.brb

---

brbb

brbb: v4b

Inherited from

Swizzle3.brbb

---

brbg

brbg: v4b

Inherited from

Swizzle3.brbg

---

brbr

brbr: v4b

Inherited from

Swizzle3.brbr

---

brg

brg: v3b

Inherited from

Swizzle3.brg

---

brgb

brgb: v4b

Inherited from

Swizzle3.brgb

---

brgg

brgg: v4b

Inherited from

Swizzle3.brgg

---

brgr

brgr: v4b

Inherited from

Swizzle3.brgr

---

brr

brr: v3b

Inherited from

Swizzle3.brr

---

brrb

brrb: v4b

Inherited from

Swizzle3.brrb

---

brrg

brrg: v4b

Inherited from

Swizzle3.brrg

---

brrr

brrr: v4b

Inherited from

Swizzle3.brrr

---

g

g: boolean

Defined in

packages/typegpu/src/data/wgslTypes.ts:345

---

gb

gb: v2b

Inherited from

Swizzle3.gb

---

gbb

gbb: v3b

Inherited from

Swizzle3.gbb

---

gbbb

gbbb: v4b

Inherited from

Swizzle3.gbbb

---

gbbg

gbbg: v4b

Inherited from

Swizzle3.gbbg

---

gbbr

gbbr: v4b

Inherited from

Swizzle3.gbbr

---

gbg

gbg: v3b

Inherited from

Swizzle3.gbg

---

gbgb

gbgb: v4b

Inherited from

Swizzle3.gbgb

---

gbgg

gbgg: v4b

Inherited from

Swizzle3.gbgg

---

gbgr

gbgr: v4b

Inherited from

Swizzle3.gbgr

---

gbr

gbr: v3b

Inherited from

Swizzle3.gbr

---

gbrb

gbrb: v4b

Inherited from

Swizzle3.gbrb

---

gbrg

gbrg: v4b

Inherited from

Swizzle3.gbrg

---

gbrr

gbrr: v4b

Inherited from

Swizzle3.gbrr

---

gg

gg: v2b

Inherited from

Swizzle3.gg

---

ggb

ggb: v3b

Inherited from

Swizzle3.ggb

---

ggbb

ggbb: v4b

Inherited from

Swizzle3.ggbb

---

ggbg

ggbg: v4b

Inherited from

Swizzle3.ggbg

---

ggbr

ggbr: v4b

Inherited from

Swizzle3.ggbr

---

ggg

ggg: v3b

Inherited from

Swizzle3.ggg

---

gggb

gggb: v4b

Inherited from

Swizzle3.gggb

---

gggg

gggg: v4b

Inherited from

Swizzle3.gggg

---

gggr

gggr: v4b

Inherited from

Swizzle3.gggr

---

ggr

ggr: v3b

Inherited from

Swizzle3.ggr

---

ggrb

ggrb: v4b

Inherited from

Swizzle3.ggrb

---

ggrg

ggrg: v4b

Inherited from

Swizzle3.ggrg

---

ggrr

ggrr: v4b

Inherited from

Swizzle3.ggrr

---

gr

gr: v2b

Inherited from

Swizzle3.gr

---

grb

grb: v3b

Inherited from

Swizzle3.grb

---

grbb

grbb: v4b

Inherited from

Swizzle3.grbb

---

grbg

grbg: v4b

Inherited from

Swizzle3.grbg

---

grbr

grbr: v4b

Inherited from

Swizzle3.grbr

---

grg

grg: v3b

Inherited from

Swizzle3.grg

---

grgb

grgb: v4b

Inherited from

Swizzle3.grgb

---

grgg

grgg: v4b

Inherited from

Swizzle3.grgg

---

grgr

grgr: v4b

Inherited from

Swizzle3.grgr

---

grr

grr: v3b

Inherited from

Swizzle3.grr

---

grrb

grrb: v4b

Inherited from

Swizzle3.grrb

---

grrg

grrg: v4b

Inherited from

Swizzle3.grrg

---

grrr

grrr: v4b

Inherited from

Swizzle3.grrr

---

kind

readonly kind: "vec3<bool>"

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

Defined in

packages/typegpu/src/data/wgslTypes.ts:340

---

length

length: 3

Inherited from

Tuple3.length

---

r

r: boolean

Defined in

packages/typegpu/src/data/wgslTypes.ts:344

---

rb

rb: v2b

Inherited from

Swizzle3.rb

---

rbb

rbb: v3b

Inherited from

Swizzle3.rbb

---

rbbb

rbbb: v4b

Inherited from

Swizzle3.rbbb

---

rbbg

rbbg: v4b

Inherited from

Swizzle3.rbbg

---

rbbr

rbbr: v4b

Inherited from

Swizzle3.rbbr

---

rbg

rbg: v3b

Inherited from

Swizzle3.rbg

---

rbgb

rbgb: v4b

Inherited from

Swizzle3.rbgb

---

rbgg

rbgg: v4b

Inherited from

Swizzle3.rbgg

---

rbgr

rbgr: v4b

Inherited from

Swizzle3.rbgr

---

rbr

rbr: v3b

Inherited from

Swizzle3.rbr

---

rbrb

rbrb: v4b

Inherited from

Swizzle3.rbrb

---

rbrg

rbrg: v4b

Inherited from

Swizzle3.rbrg

---

rbrr

rbrr: v4b

Inherited from

Swizzle3.rbrr

---

rg

rg: v2b

Inherited from

Swizzle3.rg

---

rgb

rgb: v3b

Inherited from

Swizzle3.rgb

---

rgbb

rgbb: v4b

Inherited from

Swizzle3.rgbb

---

rgbg

rgbg: v4b

Inherited from

Swizzle3.rgbg

---

rgbr

rgbr: v4b

Inherited from

Swizzle3.rgbr

---

rgg

rgg: v3b

Inherited from

Swizzle3.rgg

---

rggb

rggb: v4b

Inherited from

Swizzle3.rggb

---

rggg

rggg: v4b

Inherited from

Swizzle3.rggg

---

rggr

rggr: v4b

Inherited from

Swizzle3.rggr

---

rgr

rgr: v3b

Inherited from

Swizzle3.rgr

---

rgrb

rgrb: v4b

Inherited from

Swizzle3.rgrb

---

rgrg

rgrg: v4b

Inherited from

Swizzle3.rgrg

---

rgrr

rgrr: v4b

Inherited from

Swizzle3.rgrr

---

rr

rr: v2b

Inherited from

Swizzle3.rr

---

rrb

rrb: v3b

Inherited from

Swizzle3.rrb

---

rrbb

rrbb: v4b

Inherited from

Swizzle3.rrbb

---

rrbg

rrbg: v4b

Inherited from

Swizzle3.rrbg

---

rrbr

rrbr: v4b

Inherited from

Swizzle3.rrbr

---

rrg

rrg: v3b

Inherited from

Swizzle3.rrg

---

rrgb

rrgb: v4b

Inherited from

Swizzle3.rrgb

---

rrgg

rrgg: v4b

Inherited from

Swizzle3.rrgg

---

rrgr

rrgr: v4b

Inherited from

Swizzle3.rrgr

---

rrr

rrr: v3b

Inherited from

Swizzle3.rrr

---

rrrb

rrrb: v4b

Inherited from

Swizzle3.rrrb

---

rrrg

rrrg: v4b

Inherited from

Swizzle3.rrrg

---

rrrr

rrrr: v4b

Inherited from

Swizzle3.rrrr

---

x

x: boolean

Defined in

packages/typegpu/src/data/wgslTypes.ts:341

---

xx

xx: v2b

Inherited from

Swizzle3.xx

---

xxx

xxx: v3b

Inherited from

Swizzle3.xxx

---

xxxx

xxxx: v4b

Inherited from

Swizzle3.xxxx

---

xxxy

xxxy: v4b

Inherited from

Swizzle3.xxxy

---

xxxz

xxxz: v4b

Inherited from

Swizzle3.xxxz

---

xxy

xxy: v3b

Inherited from

Swizzle3.xxy

---

xxyx

xxyx: v4b

Inherited from

Swizzle3.xxyx

---

xxyy

xxyy: v4b

Inherited from

Swizzle3.xxyy

---

xxyz

xxyz: v4b

Inherited from

Swizzle3.xxyz

---

xxz

xxz: v3b

Inherited from

Swizzle3.xxz

---

xxzx

xxzx: v4b

Inherited from

Swizzle3.xxzx

---

xxzy

xxzy: v4b

Inherited from

Swizzle3.xxzy

---

xxzz

xxzz: v4b

Inherited from

Swizzle3.xxzz

---

xy

xy: v2b

Inherited from

Swizzle3.xy

---

xyx

xyx: v3b

Inherited from

Swizzle3.xyx

---

xyxx

xyxx: v4b

Inherited from

Swizzle3.xyxx

---

xyxy

xyxy: v4b

Inherited from

Swizzle3.xyxy

---

xyxz

xyxz: v4b

Inherited from

Swizzle3.xyxz

---

xyy

xyy: v3b

Inherited from

Swizzle3.xyy

---

xyyx

xyyx: v4b

Inherited from

Swizzle3.xyyx

---

xyyy

xyyy: v4b

Inherited from

Swizzle3.xyyy

---

xyyz

xyyz: v4b

Inherited from

Swizzle3.xyyz

---

xyz

xyz: v3b

Inherited from

Swizzle3.xyz

---

xyzx

xyzx: v4b

Inherited from

Swizzle3.xyzx

---

xyzy

xyzy: v4b

Inherited from

Swizzle3.xyzy

---

xyzz

xyzz: v4b

Inherited from

Swizzle3.xyzz

---

xz

xz: v2b

Inherited from

Swizzle3.xz

---

xzx

xzx: v3b

Inherited from

Swizzle3.xzx

---

xzxx

xzxx: v4b

Inherited from

Swizzle3.xzxx

---

xzxy

xzxy: v4b

Inherited from

Swizzle3.xzxy

---

xzxz

xzxz: v4b

Inherited from

Swizzle3.xzxz

---

xzy

xzy: v3b

Inherited from

Swizzle3.xzy

---

xzyx

xzyx: v4b

Inherited from

Swizzle3.xzyx

---

xzyy

xzyy: v4b

Inherited from

Swizzle3.xzyy

---

xzyz

xzyz: v4b

Inherited from

Swizzle3.xzyz

---

xzz

xzz: v3b

Inherited from

Swizzle3.xzz

---

xzzx

xzzx: v4b

Inherited from

Swizzle3.xzzx

---

xzzy

xzzy: v4b

Inherited from

Swizzle3.xzzy

---

xzzz

xzzz: v4b

Inherited from

Swizzle3.xzzz

---

y

y: boolean

Defined in

packages/typegpu/src/data/wgslTypes.ts:342

---

yx

yx: v2b

Inherited from

Swizzle3.yx

---

yxx

yxx: v3b

Inherited from

Swizzle3.yxx

---

yxxx

yxxx: v4b

Inherited from

Swizzle3.yxxx

---

yxxy

yxxy: v4b

Inherited from

Swizzle3.yxxy

---

yxxz

yxxz: v4b

Inherited from

Swizzle3.yxxz

---

yxy

yxy: v3b

Inherited from

Swizzle3.yxy

---

yxyx

yxyx: v4b

Inherited from

Swizzle3.yxyx

---

yxyy

yxyy: v4b

Inherited from

Swizzle3.yxyy

---

yxyz

yxyz: v4b

Inherited from

Swizzle3.yxyz

---

yxz

yxz: v3b

Inherited from

Swizzle3.yxz

---

yxzx

yxzx: v4b

Inherited from

Swizzle3.yxzx

---

yxzy

yxzy: v4b

Inherited from

Swizzle3.yxzy

---

yxzz

yxzz: v4b

Inherited from

Swizzle3.yxzz

---

yy

yy: v2b

Inherited from

Swizzle3.yy

---

yyx

yyx: v3b

Inherited from

Swizzle3.yyx

---

yyxx

yyxx: v4b

Inherited from

Swizzle3.yyxx

---

yyxy

yyxy: v4b

Inherited from

Swizzle3.yyxy

---

yyxz

yyxz: v4b

Inherited from

Swizzle3.yyxz

---

yyy

yyy: v3b

Inherited from

Swizzle3.yyy

---

yyyx

yyyx: v4b

Inherited from

Swizzle3.yyyx

---

yyyy

yyyy: v4b

Inherited from

Swizzle3.yyyy

---

yyyz

yyyz: v4b

Inherited from

Swizzle3.yyyz

---

yyz

yyz: v3b

Inherited from

Swizzle3.yyz

---

yyzx

yyzx: v4b

Inherited from

Swizzle3.yyzx

---

yyzy

yyzy: v4b

Inherited from

Swizzle3.yyzy

---

yyzz

yyzz: v4b

Inherited from

Swizzle3.yyzz

---

yz

yz: v2b

Inherited from

Swizzle3.yz

---

yzx

yzx: v3b

Inherited from

Swizzle3.yzx

---

yzxx

yzxx: v4b

Inherited from

Swizzle3.yzxx

---

yzxy

yzxy: v4b

Inherited from

Swizzle3.yzxy

---

yzxz

yzxz: v4b

Inherited from

Swizzle3.yzxz

---

yzy

yzy: v3b

Inherited from

Swizzle3.yzy

---

yzyx

yzyx: v4b

Inherited from

Swizzle3.yzyx

---

yzyy

yzyy: v4b

Inherited from

Swizzle3.yzyy

---

yzyz

yzyz: v4b

Inherited from

Swizzle3.yzyz

---

yzz

yzz: v3b

Inherited from

Swizzle3.yzz

---

yzzx

yzzx: v4b

Inherited from

Swizzle3.yzzx

---

yzzy

yzzy: v4b

Inherited from

Swizzle3.yzzy

---

yzzz

yzzz: v4b

Inherited from

Swizzle3.yzzz

---

z

z: boolean

Defined in

packages/typegpu/src/data/wgslTypes.ts:343

---

zx

zx: v2b

Inherited from

Swizzle3.zx

---

zxx

zxx: v3b

Inherited from

Swizzle3.zxx

---

zxxx

zxxx: v4b

Inherited from

Swizzle3.zxxx

---

zxxy

zxxy: v4b

Inherited from

Swizzle3.zxxy

---

zxxz

zxxz: v4b

Inherited from

Swizzle3.zxxz

---

zxy

zxy: v3b

Inherited from

Swizzle3.zxy

---

zxyx

zxyx: v4b

Inherited from

Swizzle3.zxyx

---

zxyy

zxyy: v4b

Inherited from

Swizzle3.zxyy

---

zxyz

zxyz: v4b

Inherited from

Swizzle3.zxyz

---

zxz

zxz: v3b

Inherited from

Swizzle3.zxz

---

zxzx

zxzx: v4b

Inherited from

Swizzle3.zxzx

---

zxzy

zxzy: v4b

Inherited from

Swizzle3.zxzy

---

zxzz

zxzz: v4b

Inherited from

Swizzle3.zxzz

---

zy

zy: v2b

Inherited from

Swizzle3.zy

---

zyx

zyx: v3b

Inherited from

Swizzle3.zyx

---

zyxx

zyxx: v4b

Inherited from

Swizzle3.zyxx

---

zyxy

zyxy: v4b

Inherited from

Swizzle3.zyxy

---

zyxz

zyxz: v4b

Inherited from

Swizzle3.zyxz

---

zyy

zyy: v3b

Inherited from

Swizzle3.zyy

---

zyyx

zyyx: v4b

Inherited from

Swizzle3.zyyx

---

zyyy

zyyy: v4b

Inherited from

Swizzle3.zyyy

---

zyyz

zyyz: v4b

Inherited from

Swizzle3.zyyz

---

zyz

zyz: v3b

Inherited from

Swizzle3.zyz

---

zyzx

zyzx: v4b

Inherited from

Swizzle3.zyzx

---

zyzy

zyzy: v4b

Inherited from

Swizzle3.zyzy

---

zyzz

zyzz: v4b

Inherited from

Swizzle3.zyzz

---

zz

zz: v2b

Inherited from

Swizzle3.zz

---

zzx

zzx: v3b

Inherited from

Swizzle3.zzx

---

zzxx

zzxx: v4b

Inherited from

Swizzle3.zzxx

---

zzxy

zzxy: v4b

Inherited from

Swizzle3.zzxy

---

zzxz

zzxz: v4b

Inherited from

Swizzle3.zzxz

---

zzy

zzy: v3b

Inherited from

Swizzle3.zzy

---

zzyx

zzyx: v4b

Inherited from

Swizzle3.zzyx

---

zzyy

zzyy: v4b

Inherited from

Swizzle3.zzyy

---

zzyz

zzyz: v4b

Inherited from

Swizzle3.zzyz

---

zzz

zzz: v3b

Inherited from

Swizzle3.zzz

---

zzzx

zzzx: v4b

Inherited from

Swizzle3.zzzx

---

zzzy

zzzy: v4b

Inherited from

Swizzle3.zzzy

---

zzzz

zzzz: v4b

Inherited from

Swizzle3.zzzz

Methods

[iterator]()

[iterator](): ArrayIterator<boolean>

Iterator

Returns

ArrayIterator<boolean>

Inherited from

Tuple3.[iterator]

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es2015.iterable.d.ts:78

---

at()

at(index): undefined | boolean

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

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es2022.array.d.ts:24

---

concat()

Call Signature

concat(…items): boolean[]

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

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es5.d.ts:1353

Call Signature

concat(…items): boolean[]

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

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es5.d.ts:1359

---

copyWithin()

copyWithin(target, start, end?): this

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters

target

number

If target is negative, it is treated as length+target where length is the length of the array.

start

number

If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

end?

number

If not specified, length of the this object is used as its default value.

Returns

this

Inherited from

Tuple3.copyWithin

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es2015.core.d.ts:62

---

entries()

entries(): ArrayIterator<[number, boolean]>

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

Returns

ArrayIterator<[number, boolean]>

Inherited from

Tuple3.entries

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es2015.iterable.d.ts:83

---

every()

Call Signature

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

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

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es5.d.ts:1440

Call Signature

every(predicate, thisArg?): boolean

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

Parameters

predicate

(value, index, array) => unknown

A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

thisArg?

any

An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Returns

boolean

Inherited from

Tuple3.every

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es5.d.ts:1449

---

fill()

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

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

Parameters

value

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

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es2015.core.d.ts:51

---

filter()

Call Signature

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

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

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es5.d.ts:1476

Call Signature

filter(predicate, thisArg?): boolean[]

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

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es5.d.ts:1482

---

find()

Call Signature

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

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

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es2015.core.d.ts:29

Call Signature

find(predicate, thisArg?): undefined | boolean

Parameters

predicate

(value, index, obj) => unknown

thisArg?

any

Returns

undefined | boolean

Inherited from

Tuple3.find

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es2015.core.d.ts:30

---

findIndex()

findIndex(predicate, thisArg?): number

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters

predicate

(value, index, obj) => unknown

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

thisArg?

any

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

Returns

number

Inherited from

Tuple3.findIndex

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es2015.core.d.ts:41

---

findLast()

Call Signature

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

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

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es2023.array.d.ts:29

Call Signature

findLast(predicate, thisArg?): undefined | boolean

Parameters

predicate

(value, index, array) => unknown

thisArg?

any

Returns

undefined | boolean

Inherited from

Tuple3.findLast

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es2023.array.d.ts:30

---

findLastIndex()

findLastIndex(predicate, thisArg?): number

Returns the index of the last element in the array where predicate is true, and -1 otherwise.

Parameters

predicate

(value, index, array) => unknown

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

thisArg?

any

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

Returns

number

Inherited from

Tuple3.findLastIndex

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es2023.array.d.ts:41

---

flat()

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

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type Parameters

• A

• D extends number = 1

Parameters

this

A

depth?

D

The maximum recursion depth

Returns

FlatArray<A, D>[]

Inherited from

Tuple3.flat

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es2019.array.d.ts:75

---

flatMap()

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

Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.

Type Parameters

• U

• 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

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es2019.array.d.ts:64

---

forEach()

forEach(callbackfn, thisArg?): void

Performs the specified action for each element in an array.

Parameters

callbackfn

(value, index, array) => void

A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

thisArg?

any

An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns

void

Inherited from

Tuple3.forEach

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es5.d.ts:1464

---

includes()

includes(searchElement, fromIndex?): boolean

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

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es2016.array.include.d.ts:25

---

indexOf()

indexOf(searchElement, fromIndex?): number

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

Parameters

searchElement

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

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es5.d.ts:1425

---

join()

join(separator?): string

Adds all the elements of an array into a string, separated by the specified separator string.

Parameters

separator?

string

A string used to separate one element of the array from the next in the resulting string. If omitted, the array elements are separated with a comma.

Returns

string

Inherited from

Tuple3.join

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es5.d.ts:1364

---

keys()

keys(): ArrayIterator<number>

Returns an iterable of keys in the array

Returns

ArrayIterator<number>

Inherited from

Tuple3.keys

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es2015.iterable.d.ts:88

---

lastIndexOf()

lastIndexOf(searchElement, fromIndex?): number

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

Parameters

searchElement

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

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es5.d.ts:1431

---

map()

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

Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type Parameters

• U

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

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es5.d.ts:1470

---

pop()

pop(): undefined | boolean

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

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es5.d.ts:1342

---

push()

push(…items): number

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

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es5.d.ts:1347

---

reduce()

Call Signature

reduce(callbackfn): boolean

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

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es5.d.ts:1488

Call Signature

reduce(callbackfn, initialValue): boolean

Parameters

callbackfn

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

initialValue

boolean

Returns

boolean

Inherited from

Tuple3.reduce

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es5.d.ts:1489

Call Signature

reduce<U>(callbackfn, initialValue): U

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type Parameters

• U

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

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es5.d.ts:1495

---

reduceRight()

Call Signature

reduceRight(callbackfn): boolean

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

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es5.d.ts:1501

Call Signature

reduceRight(callbackfn, initialValue): boolean

Parameters

callbackfn

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

initialValue

boolean

Returns

boolean

Inherited from

Tuple3.reduceRight

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es5.d.ts:1502

Call Signature

reduceRight<U>(callbackfn, initialValue): U

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type Parameters

• U

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

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es5.d.ts:1508

---

reverse()

reverse(): boolean[]

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

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es5.d.ts:1369

---

shift()

shift(): undefined | boolean

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

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es5.d.ts:1374

---

slice()

slice(start?, end?): boolean[]

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

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es5.d.ts:1384

---

some()

some(predicate, thisArg?): boolean

Determines whether the specified callback function returns true for any element of an array.

Parameters

predicate

(value, index, array) => unknown

A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array.

thisArg?

any

An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Returns

boolean

Inherited from

Tuple3.some

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es5.d.ts:1458

---

sort()

sort(compareFn?): this

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

Parameters

compareFn?

(a, b) => number

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

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

Returns

this

Inherited from

Tuple3.sort

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es5.d.ts:1395

---

splice()

Call Signature

splice(start, deleteCount?): boolean[]

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters

start

number

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

deleteCount?

number

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

Returns

boolean[]

An array containing the elements that were deleted.

Inherited from

Tuple3.splice

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es5.d.ts:1404

Call Signature

splice(start, deleteCount, …items): boolean[]

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters

start

number

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

deleteCount

number

The number of elements to remove. If value of this argument is either a negative number, zero, undefined, or a type that cannot be converted to an integer, the function will evaluate the argument as zero and not remove any elements.

items

…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

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es5.d.ts:1414

---

toLocaleString()

Call Signature

toLocaleString(): string

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

Returns

string

Inherited from

Tuple3.toLocaleString

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es5.d.ts:1337

Call Signature

toLocaleString(locales, options?): string

Parameters

locales

string | string[]

options?

NumberFormatOptions & DateTimeFormatOptions

Returns

string

Inherited from

Tuple3.toLocaleString

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es2015.core.d.ts:64

---

toReversed()

toReversed(): boolean[]

Returns a copy of an array with its elements reversed.

Returns

boolean[]

Inherited from

Tuple3.toReversed

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es2023.array.d.ts:46

---

toSorted()

toSorted(compareFn?): boolean[]

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

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es2023.array.d.ts:57

---

toSpliced()

Call Signature

toSpliced(start, deleteCount, …items): boolean[]

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

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es2023.array.d.ts:66

Call Signature

toSpliced(start, deleteCount?): boolean[]

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

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es2023.array.d.ts:74

---

toString()

toString(): string

Returns a string representation of an array.

Returns

string

Inherited from

Tuple3.toString

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es5.d.ts:1333

---

unshift()

unshift(…items): number

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

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es5.d.ts:1419

---

values()

values(): ArrayIterator<boolean>

Returns an iterable of values in the array

Returns

ArrayIterator<boolean>

Inherited from

Tuple3.values

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es2015.iterable.d.ts:93

---

with()

with(index, value): boolean[]

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

Defined in

node_modules/.pnpm/[email protected]/node_modules/tsover/lib/lib.es2023.array.d.ts:85