factorio-types 1.2.0 → 1.2.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "factorio-types",
-  "version": "1.2.0",
+  "version": "1.2.2",
   "description": "Typescript declarations for the Factorio mod API",
   "main": "index.d.ts",
   "repository": "https://github.com/sguest/factorio-types.git",
@@ -24,7 +24,7 @@
     "src/**/*.d.ts",
     "dist/**/*.d.ts"
   ],
-  "factorioVersion": "1.1.107",
+  "factorioVersion": "1.1.109",
   "dependencies": {
     "lua-types": "^2.13.1"
   },

package/src/core.d.ts

@@ -30,7 +30,46 @@ declare const serpent: Serpent;
 // can eventually fix these on a per-case basis
 type Table = any;
 
-// https://lua-api.factorio.com/latest/types/DataExtendMethod.html
+type uint = number;
+
+/*
+ * The data.extend method. It's the primary way to add prototypes to the data table.
+ * 
+ * The method has two positional function parameters:
+ * 
+ * - `self` :: [Data](prototype:Data): Usually provided by calling `data:extend(otherdata)`, which is syntax sugar for `data.extend(data, otherdata)`.
+ * 
+ * - `otherdata` :: array[[AnyPrototype](prototype:AnyPrototype)]: A continuous array of non-abstract prototypes.",
+ * @example
+ * ```
+ * data:extend({\n  {\n    type = \"item\",
+ *     name = \"a-thing\",
+ *     icon = \"__base__/graphics/icons/coal.png\",
+ *     icon_size = 64,
+ *     stack_size = 2
+ *   }
+ * })
+ * ```,
+ * @example
+ * ```
+ * local recipe_cat =
+ * {
+ *   type = \"recipe-category\",
+ *   name = \"my-category\"
+ * }
+ * local assembler =
+ * {
+ *   type = \"assembling-machine\",
+ *   name = \"cool-assembler\",
+ *   energy_usage = \"30kW\",
+ *   energy_source = {type = \"void\"},
+ *   crafting_speed = 1,
+ *   crafting_categories = {\"crafting\"}
+ * }
+ * 
+ * data:extend({recipe_cat, assembler})
+ * ```
+ */
 type DataExtendMethod = (data: prototype.Data, ...otherData: any[]) => void;
 
 // The docs and json definition make reference to these types but have no information as to what they are