feat: make nil types in functions constistent

ark120202 · ark120202 · commit b6363dfb0e6f · 2019-03-04T19:44:40.000+05:00
diff --git a/core/debug.d.ts b/core/debug.d.ts
@@ -81,7 +81,7 @@ declare namespace debug {
   /**
    * Returns the metatable of the given value or nil if it does not have a metatable.
    */
-  function getmetatable<T extends any>(value: T): LuaMetatable<T> | null;
+  function getmetatable<T extends any>(value: T): LuaMetatable<T> | undefined;
 
   /**
    * Returns the registry table (see §4.5).
@@ -132,18 +132,23 @@ declare namespace debug {
    *
    * See debug.getlocal for more information about variable indices and names.
    */
-  function setlocal(level: number, local: number, value: any): string | null;
-  function setlocal(thread: LuaThread, level: number, local: number, value: any): string | null;
+  function setlocal(level: number, local: number, value: any): string | undefined;
+  function setlocal(
+    thread: LuaThread,
+    level: number,
+    local: number,
+    value: any,
+  ): string | undefined;
 
   /**
    * Sets the metatable for the given value to the given table (which can be nil). Returns value.
    */
-  function setmetatable<T>(value: T, table: LuaMetatable<T> | null): T;
+  function setmetatable<T>(value: T, table: LuaMetatable<T> | null | undefined): T;
 
   /**
    * This function assigns the value value to the upvalue with index up of the function f. The function returns nil if there is no upvalue with the given index. Otherwise, it returns the name of the upvalue.
    */
-  function setupvalue(f: Function, up: number, value: any): string | null;
+  function setupvalue(f: Function, up: number, value: any): string | undefined;
 
   /**
    * Sets the given value as the Lua value associated to the given udata. udata must be a full userdata.
@@ -155,6 +160,8 @@ declare namespace debug {
   /**
    * If message is present but is neither a string nor nil, this function returns message without further processing. Otherwise, it returns a string with a traceback of the call stack. The optional message string is appended at the beginning of the traceback. An optional level number tells at which level to start the traceback (default is 1, the function calling traceback).
    */
-  function traceback(thread?: LuaThread, message?: string | null, level?: number): string;
-  function traceback<T>(thread?: LuaThread, message?: T, level?: number): T;
+  function traceback(message?: string | null, level?: number | null): string;
+  function traceback(thread?: LuaThread, message?: string | null, level?: number | null): string;
+  function traceback<T>(message: T): T;
+  function traceback<T>(thread: LuaThread, message: T): T;
 }
diff --git a/core/global.d.ts b/core/global.d.ts
@@ -70,7 +70,7 @@ declare function error(message: string, level?: number): never;
 /**
  * If object does not have a metatable, returns nil. Otherwise, if the object's metatable has a __metatable field, returns the associated value. Otherwise, returns the metatable of the given object.
  */
-declare function getmetatable<T extends object>(object: T): LuaMetatable<T> | null;
+declare function getmetatable<T extends object>(object: T): LuaMetatable<T> | undefined;
 
 /**
  * Returns three values (an iterator function, the table t, and 0) so that the construction
@@ -157,7 +157,10 @@ declare function select<T>(index: '#', ...args: T[]): number;
  *
  * This function returns table.
  */
-declare function setmetatable<T extends object>(table: T, metatable?: LuaMetatable<T>): T;
+declare function setmetatable<T extends object>(
+  table: T,
+  metatable: LuaMetatable<T> | null | undefined,
+): T;
 
 /**
  * When called with no base, tonumber tries to convert its argument to a number. If the argument is already a number or a string convertible to a number, then tonumber returns this number; otherwise, it returns nil.
@@ -166,7 +169,7 @@ declare function setmetatable<T extends object>(table: T, metatable?: LuaMetatab
  *
  * When called with base, then e must be a string to be interpreted as an integer numeral in that base. The base may be any integer between 2 and 36, inclusive. In bases above 10, the letter 'A' (in either upper or lower case) represents 10, 'B' represents 11, and so forth, with 'Z' representing 35. If the string e is not a valid numeral in the given base, the function returns nil.
  */
-declare function tonumber(e: any, base?: number): number | null;
+declare function tonumber(e: any, base?: number): number | undefined;
 
 /**
  * Receives a value of any type and converts it to a string in a human-readable format. (For complete control of how numbers are converted, use string.format.)
diff --git a/core/io.d.ts b/core/io.d.ts
@@ -150,7 +150,7 @@ interface LuaFile {
    * The default value for whence is "cur", and for offset is 0. Therefore, the call file:seek() returns the current file position, without changing it; the call file:seek("set") sets the position to the beginning of the file (and returns 0); and the call file:seek("end") sets the position to the end of the file, and returns its size.
    * @tupleReturn
    */
-  seek(whence?: 'set' | 'cur' | 'end', offset?: number): [number] | [null, string];
+  seek(whence?: 'set' | 'cur' | 'end', offset?: number): [number] | [undefined, string];
 
   /**
    * Sets the buffering mode for an output file. There are three available modes:
diff --git a/core/os.d.ts b/core/os.d.ts
@@ -69,7 +69,7 @@ declare namespace os {
   /**
    * Returns the value of the process environment variable varname, or nil if the variable is not defined.
    */
-  function getenv(varname: string): string | null;
+  function getenv(varname: string): string | undefined;
 
   /**
    * Deletes the file (or empty directory, on POSIX systems) with the given name. If this function fails, it returns nil, plus a string describing the error and the error code. Otherwise, it returns true.
@@ -95,7 +95,7 @@ declare namespace os {
   function setlocale(
     locale?: string,
     category?: 'all' | 'collate' | 'ctype' | 'monetary' | 'numeric' | 'time',
-  ): string | null;
+  ): string | undefined;
 
   /**
    * Returns the current time when called without arguments, or a time representing the local date and time specified by the given table. This table must have fields year, month, and day, and may have fields hour (default is 12), min (default is 0), sec (default is 0), and isdst (default is nil). Other fields are ignored. For a description of these fields, see the os.date function.
diff --git a/special/5.1-or-jit.d.ts b/special/5.1-or-jit.d.ts
@@ -70,9 +70,7 @@ declare namespace package {
   var loaders: (
     | (/** @tupleReturn */ (modname: string) => [(modname: string) => void])
     | (/** @tupleReturn */ <T>(modname: string) => [(modname: string, extra: T) => T, T])
-    | string
-    | undefined
-    | null)[];
+    | string)[];
 }
 
 declare namespace os {
diff --git a/special/5.2-plus.d.ts b/special/5.2-plus.d.ts
@@ -41,8 +41,7 @@ declare namespace package {
   var searchers: (
     | (/** @tupleReturn */ (modname: string) => [(modname: string) => void])
     | (/** @tupleReturn */ <T>(modname: string) => [(modname: string, extra: T) => T, T])
-    | string
-    | undefined)[];
+    | string)[];
 }
 
 declare namespace table {
diff --git a/special/5.3-plus.d.ts b/special/5.3-plus.d.ts
@@ -31,7 +31,7 @@ declare namespace math {
   /**
    * Returns "integer" if x is an integer, "float" if it is a float, or nil if x is not a number.
    */
-  function type(x: number): 'integer' | 'float' | null;
+  function type(x: number): 'integer' | 'float' | undefined;
 
   /**
    * Returns a boolean, true if and only if integer m is below integer n when they are compared as unsigned integers.

Original file line number	Diff line number	Diff line change
`@@ -41,8 +41,7 @@ declare namespace package {`
`41`	`41`	`var searchers: (`
`42`	`42`	`\| (/** @tupleReturn */ (modname: string) => [(modname: string) => void])`
`43`	`43`	`\| (/** @tupleReturn */ <T>(modname: string) => [(modname: string, extra: T) => T, T])`
`44`		`- \| string`
`45`		`- \| undefined)[];`
	`44`	`+ \| string)[];`
`46`	`45`	`}`
`47`	`46`
`48`	`47`	`declare namespace table {`