Interface LuaMap<K, V>

A convenience type for working directly with a Lua table, used as a map.

This differs from LuaTable in that the get method may return nil. For more information see: https://typescripttolua.github.io/docs/advanced/language-extensions

interface LuaMap<K extends AnyNotNil = AnyNotNil, V = any> {
    __tstlIterable: "Pairs";
    delete: LuaTableDeleteMethod<K>;
    get: LuaTableGetMethod<K, V>;
    has: LuaTableHasMethod<K>;
    set: LuaTableSetMethod<K, V>;
}

Type Parameters

K extends AnyNotNil = AnyNotNil
The type of the keys used to access the table.
V = any
The type of the values stored in the table.

Hierarchy (View Summary)

LuaPairsIterable<K, V>
- LuaMap

Index

Properties

__tstlIterable delete get has set

Properties

`Readonly`__tstlIterable

__tstlIterable: "Pairs"

delete

delete: LuaTableDeleteMethod<K>

get

get: LuaTableGetMethod<K, V>

has

has: LuaTableHasMethod<K>

set

set: LuaTableSetMethod<K, V>