feat: add all unfinished TODO types

ark120202 · ark120202 · commit bc44fdcaf3e6 · 2019-02-24T18:51:27.000+05:00
diff --git a/core/debug.d.ts b/core/debug.d.ts
@@ -97,7 +97,7 @@ declare namespace debug {
   /**
    * Returns the registry table (see §4.5).
    */
-  function getregistry(): __LUA_TODO__;
+  function getregistry(): Record<string, any>;
 
   /**
    * This function returns the name and the value of the upvalue with index up of the function f. The function returns nil if there is no upvalue with the given index.
@@ -174,10 +174,10 @@ declare namespace debug {
    *
    * These unique identifiers allow a program to check whether different closures share upvalues. Lua closures that share an upvalue (that is, that access a same external local variable) will return identical ids for those upvalue indices.
    */
-  function upvalueid(f: Function, n: number): __LUA_TODO__;
+  function upvalueid(f: Function, n: number): LuaUserdata;
 
   /**
    * Make the n1-th upvalue of the Lua closure f1 refer to the n2-th upvalue of the Lua closure f2.
    */
-  function upvaluejoin(f1: __LUA_TODO__, n1: number, f2: __LUA_TODO__, n2: number): __LUA_TODO__;
+  function upvaluejoin(f1: Function, n1: number, f2: Function, n2: number): void;
 }
diff --git a/core/global.d.ts b/core/global.d.ts
@@ -1,13 +1,12 @@
 // Based on https://www.lua.org/manual/5.3/manual.html#6.1
 
-type __LUA_TODO__ = any;
 type LuaThread = { readonly __internal__: unique symbol };
 type LuaUserdata = { readonly __internal__: unique symbol };
 
 /**
  * A global variable (not a function) that holds the global environment (see §2.2). Lua itself does not use this variable; changing its value does not affect any environment, nor vice versa.
  */
-declare const _G: any;
+declare const _G: Record<string, any>;
 
 /**
  * Calls error if the value of its argument v is false (i.e., nil or false); otherwise, returns all its arguments. In case of error, message is the error object; when absent, it defaults to "assertion failed!"
diff --git a/core/io.d.ts b/core/io.d.ts
@@ -34,7 +34,11 @@ declare namespace io {
    *
    * In case of errors this function raises the error, instead of returning an error code.
    */
-  function lines(...filename: string[]): () => __LUA_TODO__;
+  function lines(): () => string;
+  function lines<T extends FileReadFormat[]>(
+    filename: string,
+    ...formats: T
+  ): /** @tupleReturn */ () => { [P in keyof T]?: T[P] extends 'n' ? number : string };
 
   /**
    * This function opens a file, in the mode specified in the string mode. In case of success, it returns a new file handle.
@@ -67,8 +71,9 @@ declare namespace io {
 
   /**
    * Equivalent to io.input():read(···).
+   * @tupleReturn
    */
-  function read(...formats: FileReadFormat[]): __LUA_TODO__;
+  const read: file['read'];
 
   /**
    * In case of success, returns a handle for a temporary file. This file is opened in update mode and it is automatically removed when the program ends.
@@ -111,7 +116,9 @@ interface file {
    *
    * In case of errors this function raises the error, instead of returning an error code.
    */
-  lines(...formats: FileReadFormat[]): () => __LUA_TODO__;
+  lines<T extends FileReadFormat[]>(
+    ...formats: T
+  ): /** @tupleReturn */ () => { [P in keyof T]?: T[P] extends 'n' ? number : string };
 
   /**
    * Reads the file file, according to the given formats, which specify what to read. For each format, the function returns a string or a number with the characters read, or nil if it cannot read data with the specified format. (In this latter case, the function does not read subsequent formats.) When called without formats, it uses a default format that reads the next line (see below).
@@ -125,8 +132,11 @@ interface file {
    * * number: reads a string with up to this number of bytes, returning nil on end of file. If number is zero, it reads nothing and returns an empty string, or nil on end of file.
    *
    * The formats "l" and "L" should be used only for text files.
+   * @tupleReturn
    */
-  read(...formats: FileReadFormat[]): __LUA_TODO__;
+  read<T extends FileReadFormat[]>(
+    ...formats: T
+  ): { [P in keyof T]?: T[P] extends 'n' ? number : string };
 
   /**
    * Sets and geionts the file position, measured from the beginning of the file, to the posit given by offset plus a base specified by the string whence, as follows:
@@ -158,5 +168,5 @@ interface file {
    * In case of success, this function returns file. Otherwise it returns nil plus a string describing the error.
    * @tupleReturn
    */
-  write(...args: (string | number)[]): [file] | [null, string];
+  write(...args: (string | number)[]): [file] | [undefined, string];
 }
diff --git a/core/modules.d.ts b/core/modules.d.ts
@@ -43,14 +43,17 @@ declare namespace package {
 
   /**
    * Dynamically links the host program with the C library libname.
-
+   *
    * If funcname is "*", then it only links with the library, making the symbols exported by the library available to other dynamically linked libraries. Otherwise, it looks for a function funcname inside the library and returns this function as a C function. So, funcname must follow the lua_CFunction prototype (see lua_CFunction).
    *
    * This is a low-level function. It completely bypasses the package and module system. Unlike require, it does not perform any path searching and does not automatically adds extensions. libname must be the complete file name of the C library, including if necessary a path and an extension. funcname must be the exact name exported by the C library (which may depend on the C compiler and linker used).
    *
    * This function is not supported by Standard C. As such, it is only available on some platforms (Windows, Linux, Mac OS X, Solaris, BSD, plus other Unix systems that support the dlfcn standard).
    */
-  function loadlib(libname: string, funcname: string): __LUA_TODO__;
+  function loadlib(
+    libname: string,
+    funcname: string,
+  ): [Function] | [undefined, string, 'open' | 'init'];
 
   /**
    * The path used by require to search for a Lua loader.
diff --git a/core/string.d.ts b/core/string.d.ts
@@ -76,7 +76,7 @@ declare namespace string {
    *
    * For this function, a caret '^' at the start of a pattern does not work as an anchor, as this would prevent the iteration.
    */
-  function gmatch(s: string, pattern: string): __LUA_TODO__;
+  function gmatch(s: string, pattern: string): /** @tupleReturn */ () => string[];
 
   /**
    * Returns a copy of s in which all (or the first n, if given) occurrences of the pattern (see §6.4.1) have been replaced by a replacement string specified by repl, which can be a string, a table, or a function. gsub also returns, as its second value, the total number of matches that occurred. The name gsub comes from Global SUBstitution.
@@ -106,7 +106,7 @@ declare namespace string {
   /**
    * Looks for the first match of pattern (see §6.4.1) in the string s. If it finds one, then match returns the captures from the pattern; otherwise it returns nil. If pattern specifies no captures, then the whole match is returned. A third, optional numeric argument init specifies where to start the search; its default value is 1 and can be negative.
    */
-  function match(s: string, pattern: string, init?: __LUA_TODO__): string | null;
+  function match(s: string, pattern: string, init?: number): string | null;
 
   /**
    * Returns a string that is the concatenation of n copies of the string s separated by the string sep. The default value for sep is the empty string (that is, no separator). Returns the empty string if n is not positive.
diff --git a/special/5.2-plus.d.ts b/special/5.2-plus.d.ts
@@ -1,4 +1,4 @@
-declare var _ENV: any;
+declare let _ENV: Record<string, any>;
 
 /**
  * This function is a generic interface to the garbage collector. It performs different functions according to its first argument, opt.
@@ -27,7 +27,7 @@ declare function load(
   chunk: string | (() => string | null | undefined),
   chunkname?: string,
   mode?: 'b' | 't' | 'bt',
-  env?: __LUA_TODO__,
+  env?: object,
 ): [() => any] | [undefined, string];
 
 /**
@@ -37,7 +37,7 @@ declare function load(
 declare function loadfile(
   filename?: string,
   mode?: 'b' | 't' | 'bt',
-  env?: __LUA_TODO__,
+  env?: object,
 ): [() => any] | [undefined, string];
 
 /**
diff --git a/special/5.3-plus.d.ts b/special/5.3-plus.d.ts
@@ -84,7 +84,7 @@ declare namespace utf8 {
    *
    * will iterate over all characters in string s, with p being the position (in bytes) and c the code point of each character. It raises an error if it meets any invalid byte sequence.
    */
-  function codes(s: string): __LUA_TODO__;
+  function codes<S extends string>(s: S): [(s: S, index?: number) => [number, number], S, 0];
 
   /**
    * Returns the codepoints (as integers) from all characters in s that start between byte position i and j (both included). The default for i is 1 and for j is i. It raises an error if it meets any invalid byte sequence.

Original file line number	Diff line number	Diff line change
`@@ -84,7 +84,7 @@ declare namespace utf8 {`
`84`	`84`	`*`
`85`	`85`	`* will iterate over all characters in string s, with p being the position (in bytes) and c the code point of each character. It raises an error if it meets any invalid byte sequence.`
`86`	`86`	`*/`
`87`		`- function codes(s: string): __LUA_TODO__;`
	`87`	`+ function codes<S extends string>(s: S): [(s: S, index?: number) => [number, number], S, 0];`
`88`	`88`
`89`	`89`	`/**`
`90`	`90`	`* Returns the codepoints (as integers) from all characters in s that start between byte position i and j (both included). The default for i is 1 and for j is i. It raises an error if it meets any invalid byte sequence.`