lib.tstl.d.ts

//MIT License
//
//Copyright (c) 2020 Tom Blind
//
//Permission is hereby granted, free of charge, to any person obtaining a copy
//of this software and associated documentation files (the "Software"), to deal
//in the Software without restriction, including without limitation the rights
//to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
//copies of the Software, and to permit persons to whom the Software is
//furnished to do so, subject to the following conditions:
//
//The above copyright notice and this permission notice shall be included in all
//copies or substantial portions of the Software.
//
//THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
//IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
//AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
//OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
//SOFTWARE.

/** @luaTable */
declare class LuaTable<K, V> {
    public readonly length: number;
    public get(key: K): V | undefined;
    public set(key: K, value: V | undefined): void;
}

/** @luaIterator @tupleReturn */
declare interface LuaTableIterable<K, V> extends Array<[K, V]> {}

declare function pairs<K, V>(this: void, t: LuaTable<K, V>): LuaTableIterable<K, V>;
declare function pairs<T extends object>(this: void, t: T): LuaPairsIterable<T>;

/** @forRange */
declare function forRange(start: number, limit: number, step?: number): number[];

/** @varArg */
type LuaVarArg<A extends unknown[]> = A & { __luaVarArg?: never };