@defold-typescript/types 0.53.0 → 0.54.0

package/fixtures/defold-1.13.0/editor_http_doc.json

@@ -0,0 +1,273 @@
+{
+  "elements": [
+    {
+      "type": "VARIABLE",
+      "name": "http.server.local_url",
+      "brief": "editor's HTTP server local url",
+      "description": "Editor's HTTP server local url",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "VARIABLE",
+      "name": "http.server.port",
+      "brief": "editor's HTTP server port",
+      "description": "Editor's HTTP server port",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "VARIABLE",
+      "name": "http.server.url",
+      "brief": "editor's HTTP server url",
+      "description": "Editor's HTTP server url",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "http.request",
+      "brief": "perform an HTTP request",
+      "description": "Perform an HTTP request",
+      "returnvalues": [
+        {
+          "name": "response",
+          "doc": "HTTP response, a table with the following keys:<dl><dt><code>status <small>integer</small></code></dt><dd>response code</dd><dt><code>headers <small>table</small></code></dt><dd>response headers, a table where each key is a lower-cased string, and each value is either a string or an array of strings if the header was repeated</dd><dt><code>body <small>string, any, nil</small></code></dt><dd>response body, present only when <code>as</code> option was provided, either a string or a parsed json value</dd></dl>",
+          "types": ["table"]
+        }
+      ],
+      "parameters": [
+        { "name": "url", "doc": "request URL", "types": ["string"], "is_optional": "False" },
+        {
+          "name": "opts",
+          "doc": "Additional request options, a table with the following keys:<dl><dt><code>method <small>string</small></code></dt><dd>request method, defaults to <code>\"GET\"</code></dd><dt><code>headers <small>table</small></code></dt><dd>request headers, a table with string keys and values</dd><dt><code>body <small>string</small></code></dt><dd>request body</dd><dt><code>as <small>string</small></code></dt><dd>response body converter, either <code>\"string\"</code> or <code>\"json\"</code></dd></dl>",
+          "types": ["table"],
+          "is_optional": "True"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "http.server.external_file_response",
+      "brief": "create HTTP response that will stream the content of a file defined by the path",
+      "description": "Create HTTP response that will stream the content of a file defined by the path",
+      "returnvalues": [
+        { "name": "response", "doc": "HTTP response value, userdata", "types": ["response"] }
+      ],
+      "parameters": [
+        {
+          "name": "path",
+          "doc": "External file path, resolved against project root if relative",
+          "types": ["string"],
+          "is_optional": "False"
+        },
+        {
+          "name": "status",
+          "doc": "HTTP status code, an integer, default 200",
+          "types": ["integer"],
+          "is_optional": "True"
+        },
+        {
+          "name": "headers",
+          "doc": "HTTP response headers, a table from lower-case header names to header values",
+          "types": ["table&lt;string,string&gt;"],
+          "is_optional": "True"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "http.server.json_response",
+      "brief": "create HTTP response with a JSON value",
+      "description": "Create HTTP response with a JSON value",
+      "returnvalues": [
+        { "name": "response", "doc": "HTTP response value, userdata", "types": ["response"] }
+      ],
+      "parameters": [
+        {
+          "name": "value",
+          "doc": "Any Lua value that may be represented as JSON",
+          "types": ["any"],
+          "is_optional": "False"
+        },
+        {
+          "name": "status",
+          "doc": "HTTP status code, an integer, default 200",
+          "types": ["integer"],
+          "is_optional": "True"
+        },
+        {
+          "name": "headers",
+          "doc": "HTTP response headers, a table from lower-case header names to header values",
+          "types": ["table&lt;string,string&gt;"],
+          "is_optional": "True"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "http.server.resource_response",
+      "brief": "create HTTP response that will stream the content of a resource defined by the resource path",
+      "description": "Create HTTP response that will stream the content of a resource defined by the resource path",
+      "returnvalues": [
+        { "name": "response", "doc": "HTTP response value, userdata", "types": ["response"] }
+      ],
+      "parameters": [
+        {
+          "name": "resource_path",
+          "doc": "Resource path (starting with <code>/</code>)",
+          "types": ["string"],
+          "is_optional": "False"
+        },
+        {
+          "name": "status",
+          "doc": "HTTP status code, an integer, default 200",
+          "types": ["integer"],
+          "is_optional": "True"
+        },
+        {
+          "name": "headers",
+          "doc": "HTTP response headers, a table from lower-case header names to header values",
+          "types": ["table&lt;string,string&gt;"],
+          "is_optional": "True"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "http.server.response",
+      "brief": "create HTTP response",
+      "description": "Create HTTP response",
+      "returnvalues": [
+        { "name": "response", "doc": "HTTP response value, userdata", "types": ["response"] }
+      ],
+      "parameters": [
+        {
+          "name": "status",
+          "doc": "HTTP status code, an integer, default 200",
+          "types": ["integer"],
+          "is_optional": "True"
+        },
+        {
+          "name": "headers",
+          "doc": "HTTP response headers, a table from lower-case header names to header values",
+          "types": ["table&lt;string,string&gt;"],
+          "is_optional": "True"
+        },
+        { "name": "body", "doc": "HTTP response body", "types": ["string"], "is_optional": "True" }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "http.server.route",
+      "brief": "create route definition for the editor's HTTP server",
+      "description": "Create route definition for the editor's HTTP server",
+      "returnvalues": [{ "name": "route", "doc": "HTTP server route", "types": ["route"] }],
+      "parameters": [
+        {
+          "name": "path",
+          "doc": "HTTP URI path, starts with <code>/</code>; may include path patterns (<code>{name}</code> for a single segment and <code>{*name}</code> for the rest of the request path) that will be extracted from the path and provided to the handler as a part of the request",
+          "types": ["string"],
+          "is_optional": "False"
+        },
+        {
+          "name": "method",
+          "doc": "HTTP request method, default <code>\"GET\"</code>",
+          "types": ["string"],
+          "is_optional": "True"
+        },
+        {
+          "name": "as",
+          "doc": "Request body converter, either <code>\"string\"</code> or <code>\"json\"</code>; the body will be discarded if not specified",
+          "types": ["string"],
+          "is_optional": "True"
+        },
+        {
+          "name": "openapi",
+          "doc": "Optional OpenAPI Operation Object for this route method, exposed from <code>/openapi.json</code>. Must follow <code>https://spec.openapis.org/oas/v3.0.3.html#operation-object</code>.",
+          "types": ["table"],
+          "is_optional": "True"
+        },
+        {
+          "name": "handler",
+          "doc": "Request handler function, will receive request argument, a table with the following keys:<dl><dt><code>path <small>string</small></code></dt><dd>full matched path, a string starting with <code>/</code></dd><dt><code>method <small>string</small></code></dt><dd>HTTP request method, e.g. <code>\"POST\"</code></dd><dt><code>headers <small>table&lt;string,(string|string[])&gt;</small></code></dt><dd>HTTP request headers, a table from lower-case header names to header values</dd><dt><code>query <small>string</small></code></dt><dd>optional query string</dd><dt><code>body <small>string, any</small></code></dt><dd>optional request body, depends on the <code>as</code> argument</dd></dl> Handler function should return either a single response value, or 0 or more arguments to the <code>http.server.response()</code> function",
+          "types": ["function"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "Receive JSON and respond with JSON:\n<div class=\"codehilite\"><pre><span></span><code><span class=\"nv\">http</span>.<span class=\"nv\">server</span>.<span class=\"nv\">route</span><span class=\"ss\">(</span>\n  <span class=\"s2\">&quot;</span><span class=\"s\">/json</span><span class=\"s2\">&quot;</span>, <span class=\"s2\">&quot;</span><span class=\"s\">POST</span><span class=\"s2\">&quot;</span>, <span class=\"s2\">&quot;</span><span class=\"s\">json</span><span class=\"s2\">&quot;</span>,\n  <span class=\"nv\">function</span><span class=\"ss\">(</span><span class=\"nv\">request</span><span class=\"ss\">)</span>\n    <span class=\"nv\">pprint</span><span class=\"ss\">(</span><span class=\"nv\">request</span>.<span class=\"nv\">body</span><span class=\"ss\">)</span>\n    <span class=\"k\">return</span> <span class=\"mi\">200</span>\n  <span class=\"k\">end</span>\n<span class=\"ss\">)</span>\n</code></pre></div>\n\nExtract parts of the path:\n<div class=\"codehilite\"><pre><span></span><code><span class=\"nv\">http</span>.<span class=\"nv\">server</span>.<span class=\"nv\">route</span><span class=\"ss\">(</span>\n  <span class=\"s2\">&quot;</span><span class=\"s\">/users/{user}/orders</span><span class=\"s2\">&quot;</span>,\n  <span class=\"nv\">function</span><span class=\"ss\">(</span><span class=\"nv\">request</span><span class=\"ss\">)</span>\n    <span class=\"nv\">print</span><span class=\"ss\">(</span><span class=\"nv\">request</span>.<span class=\"nv\">user</span><span class=\"ss\">)</span>\n  <span class=\"k\">end</span>\n<span class=\"ss\">)</span>\n</code></pre></div>\n\nSimple file server:\n<div class=\"codehilite\"><pre><span></span><code><span class=\"nv\">http</span>.<span class=\"nv\">server</span>.<span class=\"nv\">route</span><span class=\"ss\">(</span>\n  <span class=\"s2\">&quot;</span><span class=\"s\">/files/{*file}</span><span class=\"s2\">&quot;</span>,\n  <span class=\"nv\">function</span><span class=\"ss\">(</span><span class=\"nv\">request</span><span class=\"ss\">)</span>\n    <span class=\"nv\">local</span> <span class=\"nv\">attrs</span> <span class=\"o\">=</span> <span class=\"nv\">editor</span>.<span class=\"nv\">external_file_attributes</span><span class=\"ss\">(</span><span class=\"nv\">request</span>.<span class=\"nv\">file</span><span class=\"ss\">)</span>\n    <span class=\"k\">if</span> <span class=\"nv\">attrs</span>.<span class=\"nv\">is_file</span> <span class=\"k\">then</span>\n      <span class=\"k\">return</span> <span class=\"nv\">http</span>.<span class=\"nv\">server</span>.<span class=\"nv\">external_file_response</span><span class=\"ss\">(</span><span class=\"nv\">request</span>.<span class=\"nv\">file</span><span class=\"ss\">)</span>\n    <span class=\"k\">elseif</span> <span class=\"nv\">attrs</span>.<span class=\"nv\">is_directory</span> <span class=\"k\">then</span>\n      <span class=\"k\">return</span> <span class=\"mi\">400</span>\n    <span class=\"k\">else</span>\n      <span class=\"k\">return</span> <span class=\"mi\">404</span>\n    <span class=\"k\">end</span>\n  <span class=\"k\">end</span>\n<span class=\"ss\">)</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    }
+  ],
+  "info": {
+    "namespace": "http",
+    "name": "Editor",
+    "brief": "Editor scripting documentation",
+    "description": "Editor scripting documentation",
+    "path": "engine/docs/editor.apidoc",
+    "file": "",
+    "notes": [],
+    "language": "Lua"
+  }
+}

package/fixtures/defold-1.13.0/editor_json_doc.json

@@ -0,0 +1,59 @@
+{
+  "elements": [
+    {
+      "type": "FUNCTION",
+      "name": "json.decode",
+      "brief": "decode JSON string to Lua value",
+      "description": "Decode JSON string to Lua value",
+      "returnvalues": [],
+      "parameters": [
+        { "name": "json", "doc": "json data", "types": ["string"], "is_optional": "False" },
+        {
+          "name": "options",
+          "doc": "A table with the following keys:<dl><dt><code>all <small>boolean</small></code></dt><dd>if <code>true</code>, decodes all json values in a string and returns an array</dd></dl>",
+          "types": ["table"],
+          "is_optional": "True"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "json.encode",
+      "brief": "encode Lua value to JSON string",
+      "description": "Encode Lua value to JSON string",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "value",
+          "doc": "any Lua value that may be represented as JSON",
+          "types": ["any"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    }
+  ],
+  "info": {
+    "namespace": "json",
+    "name": "Editor",
+    "brief": "Editor scripting documentation",
+    "description": "Editor scripting documentation",
+    "path": "engine/docs/editor.apidoc",
+    "file": "",
+    "notes": [],
+    "language": "Lua"
+  }
+}

package/fixtures/defold-1.13.0/editor_localization_doc.json

@@ -0,0 +1,138 @@
+{
+  "elements": [
+    {
+      "type": "FUNCTION",
+      "name": "localization.message",
+      "brief": "create a message pattern for a localization key defined in an <code>.editor_localization</code> file; the actual localization happens when the returned value is stringified",
+      "description": "Create a message pattern for a localization key defined in an <code>.editor_localization</code> file; the actual localization happens when the returned value is stringified",
+      "returnvalues": [
+        {
+          "name": "message",
+          "doc": "a userdata value that, when stringified with <code>tostring()</code>, will produce a localized text according to the currently selected language in the editor",
+          "types": ["message"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "key",
+          "doc": "localization key defined in an <code>.editor_localization</code> file",
+          "types": ["string"],
+          "is_optional": "False"
+        },
+        {
+          "name": "vars",
+          "doc": "optional table with variables to be substituted in the localized string that uses <a href=\"https://unicode-org.github.io/icu/userguide/format_parse/messages/\">ICU Message Format</a> syntax; keys must be strings; values must be either <code>nil</code>, <code>boolean</code>, <code>number</code>, <code>string</code>, or another <code>message</code> instance",
+          "types": ["table"],
+          "is_optional": "True"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "localization.and_list",
+      "brief": "create a message pattern that renders a list with the \"and\" conjunction (for example: a, b, and c) once it is stringified",
+      "description": "Create a message pattern that renders a list with the \"and\" conjunction (for example: a, b, and c) once it is stringified",
+      "returnvalues": [
+        {
+          "name": "message",
+          "doc": "a userdata value that, when stringified with <code>tostring()</code>, will produce a localized text according to the currently selected language in the editor",
+          "types": ["message"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "items",
+          "doc": "] array of values; each value may be <code>nil</code>, <code>boolean</code>, <code>number</code>, <code>string</code>, or another <code>message</code> instance",
+          "types": ["any["],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "localization.or_list",
+      "brief": "create a message pattern that renders a list with the \"or\" conjunction (for example: a, b, or c) once it is stringified",
+      "description": "Create a message pattern that renders a list with the \"or\" conjunction (for example: a, b, or c) once it is stringified",
+      "returnvalues": [
+        {
+          "name": "message",
+          "doc": "a userdata value that, when stringified with <code>tostring()</code>, will produce a localized text according to the currently selected language in the editor",
+          "types": ["message"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "items",
+          "doc": "] array of values; each value may be <code>nil</code>, <code>boolean</code>, <code>number</code>, <code>string</code>, or another <code>message</code> instance",
+          "types": ["any["],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "localization.concat",
+      "brief": "create a message pattern that concatenates values (similar to <code>table.concat</code>) and performs the actual concatenation when stringified",
+      "description": "Create a message pattern that concatenates values (similar to <code>table.concat</code>) and performs the actual concatenation when stringified",
+      "returnvalues": [
+        {
+          "name": "message",
+          "doc": "a userdata value that, when stringified with <code>tostring()</code>, will produce a localized text according to the currently selected language in the editor",
+          "types": ["message"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "items",
+          "doc": "] array of values; each value may be <code>nil</code>, <code>boolean</code>, <code>number</code>, <code>string</code>, or another <code>message</code> instance",
+          "types": ["any["],
+          "is_optional": "False"
+        },
+        {
+          "name": "separator",
+          "doc": "optional separator inserted between values; defaults to an empty string",
+          "types": ["nil", "boolean", "number", "string", "message"],
+          "is_optional": "True"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    }
+  ],
+  "info": {
+    "namespace": "localization",
+    "name": "Editor",
+    "brief": "Editor scripting documentation",
+    "description": "Editor scripting documentation",
+    "path": "engine/docs/editor.apidoc",
+    "file": "",
+    "notes": [],
+    "language": "Lua"
+  }
+}

package/fixtures/defold-1.13.0/editor_pprint_doc.json

@@ -0,0 +1,36 @@
+{
+  "elements": [
+    {
+      "type": "FUNCTION",
+      "name": "pprint",
+      "brief": "pretty-print a Lua value",
+      "description": "Pretty-print a Lua value",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "value",
+          "doc": "any Lua value to pretty-print",
+          "types": ["any"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    }
+  ],
+  "info": {
+    "namespace": "pprint",
+    "name": "Editor",
+    "brief": "Editor scripting documentation",
+    "description": "Editor scripting documentation",
+    "path": "engine/docs/editor.apidoc",
+    "file": "",
+    "notes": [],
+    "language": "Lua"
+  }
+}