Skip to content
On this page

Interface: HexIterable<T> ​

Type parameters ​

NameType
Textends Hex

Hierarchy ​

Implemented by ​

Table of contents ​

Properties ​

Methods ​

Properties ​

size ​

Readonly size: number

Inherited from ​

HexStore.size

Defined in ​

grid/types.ts:45

Methods ​

[iterator] ​

[iterator](): IterableIterator<T>

Returns ​

IterableIterator<T>

Overrides ​

Iterable.[iterator]

Defined in ​

grid/types.ts:55


filter ​

filter(predicate): HexIterable<T>

Parameters ​

NameType
predicate(hex: T) => boolean

Returns ​

HexIterable<T>

Defined in ​

grid/types.ts:56


forEach ​

forEach(fn): HexIterable<T>

Parameters ​

NameType
fn(hex: T) => void

Returns ​

HexIterable<T>

Defined in ​

grid/types.ts:58


getHex ​

getHex(coordinates): undefined | T

Parameters ​

NameType
coordinatesHexCoordinates

Returns ​

undefined | T

Inherited from ​

HexStore.getHex

Defined in ​

grid/types.ts:46


hasHex ​

hasHex(hex): boolean

Parameters ​

NameType
hexT

Returns ​

boolean

Inherited from ​

HexStore.hasHex

Defined in ​

grid/types.ts:47


map ​

map(fn): HexIterable<T>

Parameters ​

NameType
fn(hex: T) => T

Returns ​

HexIterable<T>

Defined in ​

grid/types.ts:57


reduce ​

reduce(reducer): T

Parameters ​

NameType
reducer(previousHex: T, currentHex: T) => T

Returns ​

T

Defined in ​

grid/types.ts:59

reduce(reducer, initialValue): T

Parameters ​

NameType
reducer(previousHex: T, currentHex: T) => T
initialValueT

Returns ​

T

Defined in ​

grid/types.ts:60

reduce<R>(reducer, initialValue): R

Type parameters ​

Name
R

Parameters ​

NameType
reducer(result: R, hex: T) => R
initialValueR

Returns ​

R

Defined in ​

grid/types.ts:61


setHexes ​

setHexes(hexesOrCoordinates): HexIterable<T>

Parameters ​

NameType
hexesOrCoordinatesIterable<HexCoordinates | T>

Returns ​

HexIterable<T>

Inherited from ​

HexStore.setHexes

Defined in ​

grid/types.ts:48


toArray ​

toArray(): T[]

Returns ​

T[]

Defined in ​

grid/types.ts:62

Released under the MIT License.