@defold-typescript/types 0.52.0 → 0.54.0

package/fixtures/defold-1.13.1/os_doc.json

@@ -0,0 +1,266 @@
+{
+  "elements": [
+    {
+      "type": "FUNCTION",
+      "name": "os.clock",
+      "brief": "amount of elapsed/CPU time used (depending on OS)",
+      "description": "Returns an approximation of the amount in seconds of CPU time\nused by the program.",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "os.date",
+      "brief": "formats a date/time string",
+      "description": "Returns a string or a table containing date and time,\nformatted according to the given string format.\nIf the time argument is present,\nthis is the time to be formatted\n(see the os.time function for a description of this value).\nOtherwise, date formats the current time.\nIf format starts with '!',\nthen the date is formatted in Coordinated Universal Time.\nAfter this optional character,\nif format is the string \"*t\",\nthen date returns a table with the following fields:\nyear (four digits), month (1--12), day (1--31),\nhour (0--23), min (0--59), sec (0--61),\nwday (weekday, Sunday is 1),\nyday (day of the year),\nand isdst (daylight saving flag, a boolean).\nIf format is not \"*t\",\nthen date returns the date as a string,\nformatted according to the same rules as the C function strftime.\nWhen called without arguments,\ndate returns a reasonable date and time representation that depends on\nthe host system and on the current locale\n(that is, <code>os.date()</code> is equivalent to <code>os.date(\"%c\")</code>).",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "format",
+          "doc": "",
+          "types": ["string"],
+          "is_optional": "True"
+        },
+        {
+          "name": "time",
+          "doc": "",
+          "types": ["number"],
+          "is_optional": "True"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "os.difftime",
+      "brief": "calculates a time difference in seconds",
+      "description": "Returns the number of seconds from time t1 to time t2.\nIn POSIX, Windows, and some other systems,\nthis value is exactly t2-t1.",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "t2",
+          "doc": "",
+          "types": ["number"],
+          "is_optional": "False"
+        },
+        {
+          "name": "t1",
+          "doc": "",
+          "types": ["number"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "os.execute",
+      "brief": "executes an operating system command",
+      "description": "This function is equivalent to the C function system.\nIt passes command to be executed by an operating system shell.\nIt returns a status code, which is system-dependent.\nIf command is absent, then it returns nonzero if a shell is available\nand zero otherwise.",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "command",
+          "doc": "",
+          "types": ["string"],
+          "is_optional": "True"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "os.exit",
+      "brief": "attempts to terminate the process",
+      "description": "Calls the C function exit,\nwith an optional code,\nto terminate the host program.\nThe default value for code is the success code.\nCalling os.exit will do a hard exit which will not run\nthe engine shutdown code. This may cause crashes on exit.\nThe recommended way to terminate your game is by using\nthe exit message which does a graceful shutdown.\n<code>msg.post(\"@system:\", \"exit\", {code = 0})</code>",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "code",
+          "doc": "",
+          "types": ["number"],
+          "is_optional": "True"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "os.getenv",
+      "brief": "returns an operating system environment variable",
+      "description": "Returns the value of the process environment variable varname,\nor <span class=\"type\"> nil</span> if the variable is not defined.",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "varname",
+          "doc": "",
+          "types": ["string"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "os.remove",
+      "brief": "deletes a file",
+      "description": "Deletes the file or directory with the given name.\nDirectories must be empty to be removed.\nIf this function fails, it returns <span class=\"type\"> nil</span>,\nplus a string describing the error.",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "filename",
+          "doc": "",
+          "types": ["string"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "os.rename",
+      "brief": "renames a file",
+      "description": "Renames file or directory named oldname to newname.\nIf this function fails, it returns <span class=\"type\"> nil</span>,\nplus a string describing the error.",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "oldname",
+          "doc": "",
+          "types": ["string"],
+          "is_optional": "False"
+        },
+        {
+          "name": "newname",
+          "doc": "",
+          "types": ["string"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "os.setlocale",
+      "brief": "sets the current locale to the supplied locale",
+      "description": "Sets the current locale of the program.\nlocale is a string specifying a locale;\ncategory is an optional string describing which category to change:\n<code>\"all\"</code>, <code>\"collate\"</code>, <code>\"ctype\"</code>,\n<code>\"monetary\"</code>, <code>\"numeric\"</code>, or <code>\"time\"</code>;\nthe default category is <code>\"all\"</code>.\nThe function returns the name of the new locale,\nor <span class=\"type\"> nil</span> if the request cannot be honored.\nIf locale is the empty string,\nthe current locale is set to an implementation-defined native locale.\nIf locale is the string \"C\",\nthe current locale is set to the standard C locale.\nWhen called with <span class=\"type\"> nil</span> as the first argument,\nthis function only returns the name of the current locale\nfor the given category.",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "locale",
+          "doc": "",
+          "types": ["string"],
+          "is_optional": "False"
+        },
+        {
+          "name": "category",
+          "doc": "",
+          "types": ["string"],
+          "is_optional": "True"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "os.time",
+      "brief": "returns the current time or calculates the time in seconds from a table",
+      "description": "Returns the current time when called without arguments,\nor a time representing the date and time specified by the given table.\nThis table must have fields year, month, and day,\nand may have fields hour, min, sec, and isdst\n(for a description of these fields, see the os.date function).\nThe returned value is a number, whose meaning depends on your system.\nIn POSIX, Windows, and some other systems, this number counts the number\nof seconds since some given start time (the \"epoch\").\nIn other systems, the meaning is not specified,\nand the number returned by time can be used only as an argument to\ndate and difftime.",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "table",
+          "doc": "",
+          "types": ["table"],
+          "is_optional": "True"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "os.tmpname",
+      "brief": "returns a name for a temporary file",
+      "description": "Returns a string with a file name that can\nbe used for a temporary file.\nThe file must be explicitly opened before its use\nand explicitly removed when no longer needed.\nOn some systems (POSIX),\nthis function also creates a file with that name,\nto avoid security risks.\n(Someone else might create the file with wrong permissions\nin the time between getting the name and creating the file.)\nYou still have to open the file to use it\nand to remove it (even if you do not use it).\nWhen possible,\nyou may prefer to use io.tmpfile,\nwhich automatically removes the file when the program ends.",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    }
+  ],
+  "info": {
+    "namespace": "os",
+    "name": "Os",
+    "brief": "Lua os standard library",
+    "description": "Documentation for the Lua os standard library.\n\nFrom [Lua 5.1 Reference Manual](https://www.lua.org/manual/5.1/)\nby Roberto Ierusalimschy, Luiz Henrique de Figueiredo, Waldemar Celes.\n\nCopyright &copy; 2006-2012 Lua.org, PUC-Rio.\n\nFreely available under the terms of the [Lua license](https://www.lua.org/license.html).",
+    "path": "engine/lua/src/lua_os.doc_h",
+    "file": "",
+    "notes": [],
+    "language": "Lua"
+  }
+}

package/fixtures/defold-1.13.1/package_doc.json

@@ -0,0 +1,139 @@
+{
+  "elements": [
+    {
+      "type": "FUNCTION",
+      "name": "package.cpath",
+      "brief": "search path used for loading DLLs using the <code>require</code> function",
+      "description": "The path used by require to search for a C loader.\nLua initializes the C path package.cpath in the same way\nit initializes the Lua path package.path,\nusing the environment variable LUA_CPATH\nor a default path defined in luaconf.h.",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "package.loaded",
+      "brief": "table of loaded packages",
+      "description": "A table used by require to control which\nmodules are already loaded.\nWhen you require a module modname and\n<code>package.loaded[modname]</code> is not false,\nrequire simply returns the value stored there.",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "package.loaders",
+      "brief": "table of package loaders",
+      "description": "A table used by require to control how to load modules.\nEach entry in this table is a searcher function.\nWhen looking for a module,\nrequire calls each of these searchers in ascending order,\nwith the module name (the argument given to require) as its\nsole parameter.\nThe function can return another function (the module loader)\nor a string explaining why it did not find that module\n(or <span class=\"type\"> nil</span> if it has nothing to say).\nLua initializes this table with four functions.\nThe first searcher simply looks for a loader in the\npackage.preload table.\nThe second searcher looks for a loader as a Lua library,\nusing the path stored at package.path.\nA path is a sequence of <em>templates</em> separated by semicolons.\nFor each template,\nthe searcher will change each interrogation\nmark in the template by filename,\nwhich is the module name with each dot replaced by a\n\"directory separator\" (such as \"/\" in Unix);\nthen it will try to open the resulting file name.\nSo, for instance, if the Lua path is the string\n<div class=\"codehilite\"><pre><span></span><code><span class=\"s2\">&quot;./?.lua;./?.lc;/usr/local/?/init.lua&quot;</span>\n</code></pre></div>\n\nthe search for a Lua file for module foo\nwill try to open the files\n<code>./foo.lua</code>, <code>./foo.lc</code>, and\n<code>/usr/local/foo/init.lua</code>, in that order.\nThe third searcher looks for a loader as a C library,\nusing the path given by the variable package.cpath.\nFor instance,\nif the C path is the string\n<div class=\"codehilite\"><pre><span></span><code><span class=\"s2\">&quot;./?.so;./?.dll;/usr/local/?/init.so&quot;</span>\n</code></pre></div>\n\nthe searcher for module foo\nwill try to open the files <code>./foo.so</code>, <code>./foo.dll</code>,\nand <code>/usr/local/foo/init.so</code>, in that order.\nOnce it finds a C library,\nthis searcher first uses a dynamic link facility to link the\napplication with the library.\nThen it tries to find a C function inside the library to\nbe used as the loader.\nThe name of this C function is the string \"luaopen_\"\nconcatenated with a copy of the module name where each dot\nis replaced by an underscore.\nMoreover, if the module name has a hyphen,\nits prefix up to (and including) the first hyphen is removed.\nFor instance, if the module name is a.v1-b.c,\nthe function name will be luaopen_b_c.\nThe fourth searcher tries an all-in-one loader.\nIt searches the C path for a library for\nthe root name of the given module.\nFor instance, when requiring a.b.c,\nit will search for a C library for a.\nIf found, it looks into it for an open function for\nthe submodule;\nin our example, that would be luaopen_a_b_c.\nWith this facility, a package can pack several C submodules\ninto one single library,\nwith each submodule keeping its original open function.",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "package.loadlib",
+      "brief": "loads a dynamic link library (DLL)",
+      "description": "Dynamically links the host program with the C library libname.\nInside this library, looks for a function funcname\nand returns this function as a C function.\n(So, funcname must follow the protocol ).\nThis is a low-level function.\nIt completely bypasses the package and module system.\nUnlike require,\nit does not perform any path searching and\ndoes not automatically adds extensions.\nlibname must be the complete file name of the C library,\nincluding if necessary a path and extension.\nfuncname must be the exact name exported by the C library\n(which may depend on the C compiler and linker used).\nThis function is not supported by ANSI C.\nAs such, it is only available on some platforms\n(Windows, Linux, Mac OS X, Solaris, BSD,\nplus other Unix systems that support the dlfcn standard).",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "libname",
+          "doc": "",
+          "types": ["string"],
+          "is_optional": "False"
+        },
+        {
+          "name": "funcname",
+          "doc": "",
+          "types": ["string"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "package.path",
+      "brief": "search path used for loading Lua code using the <code>require</code> function",
+      "description": "The path used by require to search for a Lua loader.\nAt start-up, Lua initializes this variable with\nthe value of the environment variable LUA_PATH or\nwith a default path defined in luaconf.h,\nif the environment variable is not defined.\nAny \";;\" in the value of the environment variable\nis replaced by the default path.",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "package.preload",
+      "brief": "a table of special function loaders",
+      "description": "A table to store loaders for specific modules\n.",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "package.seeall",
+      "brief": "sets a metatable for the module so it can see global variables",
+      "description": "Sets a metatable for module with\nits __index field referring to the global environment,\nso that this module inherits values\nfrom the global environment.\nTo be used as an option to function module.",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "module",
+          "doc": "",
+          "types": ["table"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    }
+  ],
+  "info": {
+    "namespace": "package",
+    "name": "Package",
+    "brief": "Lua package standard library",
+    "description": "Documentation for the Lua package standard library.\n\nFrom [Lua 5.1 Reference Manual](https://www.lua.org/manual/5.1/)\nby Roberto Ierusalimschy, Luiz Henrique de Figueiredo, Waldemar Celes.\n\nCopyright &copy; 2006-2012 Lua.org, PUC-Rio.\n\nFreely available under the terms of the [Lua license](https://www.lua.org/license.html).",
+    "path": "engine/lua/src/lua_package.doc_h",
+    "file": "",
+    "notes": [],
+    "language": "Lua"
+  }
+}