Interface LuaTable<TKey, TValue>

A convenience type for working directly with a Lua table. For more information see: https://typescripttolua.github.io/docs/advanced/language-extensions

interface LuaTable<TKey extends AnyNotNil = AnyNotNil, TValue = any> {
    __tstlIterable: "Pairs";
    delete: LuaTableDeleteMethod<TKey>;
    get: LuaTableGetMethod<TKey, TValue>;
    has: LuaTableHasMethod<TKey>;
    length: LuaLengthMethod<number>;
    set: LuaTableSetMethod<TKey, TValue>;
}

Type Parameters

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

Hierarchy (View Summary)

LuaPairsIterable<TKey, TValue>
- LuaTable

Index

Properties

__tstlIterable delete get has length set

Properties

`Readonly`__tstlIterable

__tstlIterable: "Pairs"

delete

delete: LuaTableDeleteMethod<TKey>

get

get: LuaTableGetMethod<TKey, TValue>

has

has: LuaTableHasMethod<TKey>

length

length: LuaLengthMethod<number>

set

set: LuaTableSetMethod<TKey, TValue>