@defold-typescript/types 0.53.0 → 0.54.0

package/fixtures/defold-1.12.4/coroutine_doc.json

@@ -0,0 +1,151 @@
+{
+  "elements": [
+    {
+      "type": "FUNCTION",
+      "name": "coroutine.create",
+      "brief": "creates a new coroutine thread",
+      "description": "Creates a new coroutine, with body f.\nf must be a Lua function.\nReturns this new coroutine,\nan object with type <code>\"thread\"</code>.",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "f",
+          "doc": "",
+          "types": ["function"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "coroutine.resume",
+      "brief": "start or resume a thread",
+      "description": "Starts or continues the execution of coroutine co.\nThe first time you resume a coroutine,\nit starts running its body.\nThe values val1, ... are passed\nas the arguments to the body function.\nIf the coroutine has yielded,\nresume restarts it;\nthe values val1, ... are passed\nas the results from the yield.\nIf the coroutine runs without any errors,\nresume returns <span class=\"type\"> true</span> plus any values passed to yield\n(if the coroutine yields) or any values returned by the body function\n(if the coroutine terminates).\nIf there is any error,\nresume returns <span class=\"type\"> false</span> plus the error message.",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "co",
+          "doc": "",
+          "types": ["thread"],
+          "is_optional": "False"
+        },
+        {
+          "name": "val1",
+          "doc": "",
+          "types": ["any"],
+          "is_optional": "True"
+        },
+        {
+          "name": "...",
+          "doc": "",
+          "types": [""],
+          "is_optional": "True"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "coroutine.running",
+      "brief": "returns the running coroutine",
+      "description": "Returns the running coroutine,\nor <span class=\"type\"> nil</span> when called by the main thread.",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "coroutine.status",
+      "brief": "returns the status of a thread",
+      "description": "Returns the status of coroutine co, as a string:\n<code>\"running\"</code>,\nif the coroutine is running (that is, it called status);\n<code>\"suspended\"</code>, if the coroutine is suspended in a call to yield,\nor if it has not started running yet;\n<code>\"normal\"</code> if the coroutine is active but not running\n(that is, it has resumed another coroutine);\nand <code>\"dead\"</code> if the coroutine has finished its body function,\nor if it has stopped with an error.",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "co",
+          "doc": "",
+          "types": ["thread"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "coroutine.wrap",
+      "brief": "creates a thread and returns a function to resume it",
+      "description": "Creates a new coroutine, with body f.\nf must be a Lua function.\nReturns a function that resumes the coroutine each time it is called.\nAny arguments passed to the function behave as the\nextra arguments to resume.\nReturns the same values returned by resume,\nexcept the first boolean.\nIn case of error, propagates the error.",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "f",
+          "doc": "",
+          "types": ["function"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "coroutine.yield",
+      "brief": "yields execution of thread back to the caller",
+      "description": "Suspends the execution of the calling coroutine.\nThe coroutine cannot be running a C function,\na metamethod, or an iterator.\nAny arguments to yield are passed as extra results to resume.",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "...",
+          "doc": "",
+          "types": [""],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    }
+  ],
+  "info": {
+    "namespace": "coroutine",
+    "name": "Coroutine",
+    "brief": "Lua coroutine standard library",
+    "description": "Documentation for the Lua coroutine 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_coroutine.doc_h",
+    "file": "",
+    "notes": [],
+    "language": "Lua"
+  }
+}

package/fixtures/defold-1.12.4/crash_doc.json

@@ -0,0 +1,497 @@
+{
+  "elements": [
+    {
+      "type": "FUNCTION",
+      "name": "crash.write_dump",
+      "brief": "writes crash dump",
+      "description": "Performs the same steps as if a crash had just occured but\nallows the program to continue.\nThe generated dump can be read by crash.load_previous",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "crash.set_file_path",
+      "brief": "sets the file location for crash dumps",
+      "description": "Crashes occuring before the path is set will be stored to a default engine location.",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "path",
+          "doc": "file path to use",
+          "types": ["string"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "crash.load_previous",
+      "brief": "loads a previously written crash dump",
+      "description": "The crash dump will be removed from disk upon a successful\nload, so loading is one-shot.",
+      "returnvalues": [
+        {
+          "name": "handle",
+          "doc": "handle to the loaded dump, or <code>nil</code> if no dump was found",
+          "types": ["number", "nil"]
+        }
+      ],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "crash.release",
+      "brief": "releases a previously loaded crash dump",
+      "description": "releases a previously loaded crash dump",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "handle",
+          "doc": "handle to loaded crash dump",
+          "types": ["number"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "crash.set_user_field",
+      "brief": "stores user-defined string value",
+      "description": "Store a user value that will get written to a crash dump when\na crash occurs. This can be user id:s, breadcrumb data etc.\nThere are 32 slots indexed from 0. Each slot stores at most 255 characters.",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "index",
+          "doc": "slot index. 0-indexed",
+          "types": ["number"],
+          "is_optional": "False"
+        },
+        {
+          "name": "value",
+          "doc": "string value to store",
+          "types": ["string"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "crash.get_modules",
+      "brief": "get all loaded modules from when the crash occured",
+      "description": "The function returns a table containing entries with sub-tables that\nhave fields 'name' and 'address' set for all loaded modules.",
+      "returnvalues": [
+        {
+          "name": "modules",
+          "doc": "module table",
+          "types": ["table"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "handle",
+          "doc": "crash dump handle",
+          "types": ["number"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "crash.get_user_field",
+      "brief": "reads user field from a loaded crash dump",
+      "description": "reads user field from a loaded crash dump",
+      "returnvalues": [
+        {
+          "name": "value",
+          "doc": "user data value recorded in the crash dump",
+          "types": ["string"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "handle",
+          "doc": "crash dump handle",
+          "types": ["number"],
+          "is_optional": "False"
+        },
+        {
+          "name": "index",
+          "doc": "user data slot index",
+          "types": ["number"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "crash.get_sys_field",
+      "brief": "reads a system field from a loaded crash dump",
+      "description": "reads a system field from a loaded crash dump",
+      "returnvalues": [
+        {
+          "name": "value",
+          "doc": "value recorded in the crash dump, or <code>nil</code> if it didn't exist",
+          "types": ["string", "nil"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "handle",
+          "doc": "crash dump handle",
+          "types": ["number"],
+          "is_optional": "False"
+        },
+        {
+          "name": "index",
+          "doc": "system field enum. Must be less than <a href=\"/ref/crash#crash.SYSFIELD_MAX\">crash.SYSFIELD_MAX</a>",
+          "types": ["number"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "crash.get_signum",
+      "brief": "read signal number from a crash report",
+      "description": "read signal number from a crash report",
+      "returnvalues": [
+        {
+          "name": "signal",
+          "doc": "signal number",
+          "types": ["number"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "handle",
+          "doc": "crash dump handle",
+          "types": ["number"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "crash.get_backtrace",
+      "brief": "read backtrace recorded in a loaded crash dump",
+      "description": "A table is returned containing the addresses of the call stack.",
+      "returnvalues": [
+        {
+          "name": "backtrace",
+          "doc": "table containing the backtrace",
+          "types": ["table"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "handle",
+          "doc": "crash dump handle",
+          "types": ["number"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "crash.get_extra_data",
+      "brief": "read text blob recorded in a crash dump",
+      "description": "The format of read text blob is platform specific\nand not guaranteed\nbut can be useful for manual inspection.",
+      "returnvalues": [
+        {
+          "name": "blob",
+          "doc": "string with the platform specific data",
+          "types": ["string"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "handle",
+          "doc": "crash dump handle",
+          "types": ["number"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "CONSTANT",
+      "name": "crash.SYSFIELD_ENGINE_VERSION",
+      "brief": "engine version as release number",
+      "description": "engine version as release number",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "CONSTANT",
+      "name": "crash.SYSFIELD_ENGINE_HASH",
+      "brief": "engine version as hash",
+      "description": "engine version as hash",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "CONSTANT",
+      "name": "crash.SYSFIELD_DEVICE_MODEL",
+      "brief": "device model as reported by sys.get_sys_info",
+      "description": "device model as reported by sys.get_sys_info",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "CONSTANT",
+      "name": "crash.SYSFIELD_MANUFACTURER",
+      "brief": "device manufacturer as reported by sys.get_sys_info",
+      "description": "device manufacturer as reported by sys.get_sys_info",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "CONSTANT",
+      "name": "crash.SYSFIELD_SYSTEM_NAME",
+      "brief": "system name as reported by sys.get_sys_info",
+      "description": "system name as reported by sys.get_sys_info",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "CONSTANT",
+      "name": "crash.SYSFIELD_SYSTEM_VERSION",
+      "brief": "system version as reported by sys.get_sys_info",
+      "description": "system version as reported by sys.get_sys_info",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "CONSTANT",
+      "name": "crash.SYSFIELD_LANGUAGE",
+      "brief": "system language as reported by sys.get_sys_info",
+      "description": "system language as reported by sys.get_sys_info",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "CONSTANT",
+      "name": "crash.SYSFIELD_DEVICE_LANGUAGE",
+      "brief": "system device language as reported by sys.get_sys_info",
+      "description": "system device language as reported by sys.get_sys_info",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "CONSTANT",
+      "name": "crash.SYSFIELD_TERRITORY",
+      "brief": "system territory as reported by sys.get_sys_info",
+      "description": "system territory as reported by sys.get_sys_info",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "CONSTANT",
+      "name": "crash.SYSFIELD_ANDROID_BUILD_FINGERPRINT",
+      "brief": "android build fingerprint",
+      "description": "android build fingerprint",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "CONSTANT",
+      "name": "crash.SYSFIELD_MAX",
+      "brief": "The max number of sysfields.",
+      "description": "The max number of sysfields.",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "CONSTANT",
+      "name": "crash.USERFIELD_MAX",
+      "brief": "The max number of user fields.",
+      "description": "The max number of user fields.",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "CONSTANT",
+      "name": "crash.USERFIELD_SIZE",
+      "brief": "The max size of a single user field.",
+      "description": "The max size of a single user field.",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    }
+  ],
+  "info": {
+    "namespace": "crash",
+    "name": "Crash",
+    "brief": "Crash API documentation",
+    "description": "Native crash logging functions and constants.",
+    "path": "engine/crash/src/script_crash.cpp",
+    "file": "",
+    "notes": [],
+    "language": "Lua"
+  }
+}