Class: MockLuaMap<K, V>

Mock tstl map data structure. In runtime objects, arrays and tables are same, but in test env have to mock them with compat and workarounds.

Extends

• Map<K, V>

Type Parameters

Type Parameter	Default type
K	unknown
V	unknown

Constructors

Constructor

new MockLuaMap<K, V>(entries?: readonly readonly [K, V][] | null): MockLuaMap<K, V>;

Parameters

Parameter	Type
entries?	readonly readonly [K, V][] | null

Returns

MockLuaMap<K, V>

Inherited from

Map<K, V>.constructor

Constructor

new MockLuaMap<K, V>(iterable?: Iterable<readonly [K, V], any, any> | null): MockLuaMap<K, V>;

Parameters

Parameter	Type
iterable?	Iterable<readonly [K, V], any, any> | null

Returns

MockLuaMap<K, V>

Inherited from

Map<K, V>.constructor

Methods

getEntriesArray()

getEntriesArray(): [K, V][];

Returns

[K, V][]

---

getKeysArray()

getKeysArray(): K[];

Returns

K[]

---

getValuesArray()

getValuesArray(): V[];

Returns

V[]

---

has()

has(key: K): boolean;

Parameters

Parameter	Type
key	K

Returns

boolean

boolean indicating whether an element with the specified key exists or not.

Overrides

Map.has

---

isEmpty()

isEmpty(): boolean;

Check if table is empty.

Returns

boolean

---

length()

length(): number;

Returns

number

---

map()

map<U>(cb: (value: V, index: number, array: V[]) => U): U[];

Type Parameters

Type Parameter
U

Parameters

Parameter	Type
cb	(value: V, index: number, array: V[]) => U

Returns

U[]

---

reset()

reset(): void;

Returns

void

---

create()

static create<K, V>(): MockLuaMap<K, V>;

Type Parameters

Type Parameter
K extends AnyNotNil
V

Returns

MockLuaMap<K, V>

---

fromArray()

static fromArray<T>(from: T[], into?: MockLuaMap<number, T>): MockLuaMap<number, T>;

Create new map from JS array.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
from	T[]
into	MockLuaMap<number, T>

Returns

MockLuaMap<number, T>

---

fromObject()

static fromObject<K, T>(from: Record<K, T>): MockLuaMap<K, T>;

Create new map from JS object.

Type Parameters

Type Parameter
K extends string | number | symbol
T

Parameters

Parameter	Type
from	Record<K, T>

Returns

MockLuaMap<K, T>

---

getSizeOf()

static getSizeOf(table: 
  | LuaTable<any, any>
  | LuaMap<any, any>
  | Map<any, any>
  | AnyObject): number;

Get mock size in unified way.

Parameters

Parameter	Type
table	| LuaTable<any, any> | LuaMap<any, any> | Map<any, any> | AnyObject

Returns

number

---

mock()

static mock<K, V>(initial?: [K, V][]): LuaTable<K, V>;

Type Parameters

Type Parameter
K extends AnyNotNil
V

Parameters

Parameter	Type	Default value
initial	[K, V][]	[]

Returns

LuaTable<K, V>

---

mockFromObject()

static mockFromObject<K, T>(from: Record<K, T>): MockLuaMap<K, T>;

Create new map from JS array.

Type Parameters

Type Parameter
K extends string | number | symbol
T

Parameters

Parameter	Type
from	Record<K, T>

Returns

MockLuaMap<K, T>

---

mockToObject()

static mockToObject<K, T>(from: MockLuaMap<K, T>): Record<K, T>;

Create new object from LUA table.

Type Parameters

Type Parameter
K extends string | number | symbol
T

Parameters

Parameter	Type
from	MockLuaMap<K, T>

Returns

Record<K, T>

---

toObject()

static toObject<K, T>(from: MockLuaMap<K, T>): Record<K, T>;

Create new object from lua mock.

Type Parameters

Type Parameter
K extends string | number | symbol
T

Parameters

Parameter	Type
from	MockLuaMap<K, T>

Returns

Record<K, T>