@girs/gobject-2.0 2.80.0-4.0.0-beta.4 → 2.80.3-4.0.0-beta.6

package/README.md

@@ -5,7 +5,7 @@
 ![downloads/week](https://img.shields.io/npm/dw/@girs/gobject-2.0)
 
 
-GJS TypeScript type definitions for GObject-2.0, generated from library version 2.80.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0-beta.3.
+GJS TypeScript type definitions for GObject-2.0, generated from library version 2.80.3 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0-beta.6.
 
 
 ## Install

package/gobject-2.0.d.ts

@@ -3036,10 +3036,45 @@ export namespace GObject {
 
         // Own virtual methods of GObject.Object
 
+        /**
+         * the `constructed` function is called by g_object_new() as the
+         *  final step of the object creation process.  At the point of the call, all
+         *  construction properties have been set on the object.  The purpose of this
+         *  call is to allow for object initialisation steps that can only be performed
+         *  after construction properties have been set.  `constructed` implementors
+         *  should chain up to the `constructed` call of their parent class to allow it
+         *  to complete its initialisation.
+         */
         vfunc_constructed(): void;
+        /**
+         * emits property change notification for a bunch
+         *  of properties. Overriding `dispatch_properties_changed` should be rarely
+         *  needed.
+         * @param n_pspecs
+         * @param pspecs
+         */
         vfunc_dispatch_properties_changed(n_pspecs: number, pspecs: ParamSpec): void;
+        /**
+         * the `dispose` function is supposed to drop all references to other
+         *  objects, but keep the instance otherwise intact, so that client method
+         *  invocations still work. It may be run multiple times (due to reference
+         *  loops). Before returning, `dispose` should chain up to the `dispose` method
+         *  of the parent class.
+         */
         vfunc_dispose(): void;
+        /**
+         * instance finalization function, should finish the finalization of
+         *  the instance begun in `dispose` and chain up to the `finalize` method of the
+         *  parent class.
+         */
         vfunc_finalize(): void;
+        /**
+         * the generic getter for all properties of this type. Should be
+         *  overridden for every type with properties.
+         * @param property_id
+         * @param value
+         * @param pspec
+         */
         vfunc_get_property(property_id: number, value: Value | any, pspec: ParamSpec): void;
         /**
          * Emits a "notify" signal for the property `property_name` on `object`.
@@ -3055,6 +3090,16 @@ export namespace GObject {
          * @param pspec
          */
         vfunc_notify(pspec: ParamSpec): void;
+        /**
+         * the generic setter for all properties of this type. Should be
+         *  overridden for every type with properties. If implementations of
+         *  `set_property` don't emit property change notification explicitly, this will
+         *  be done implicitly by the type system. However, if the notify signal is
+         *  emitted explicitly, the type system will not emit it a second time.
+         * @param property_id
+         * @param value
+         * @param pspec
+         */
         vfunc_set_property(property_id: number, value: Value | any, pspec: ParamSpec): void;
 
         // Own methods of GObject.Object
@@ -3584,10 +3629,38 @@ export namespace GObject {
 
         // Own virtual methods of GObject.ParamSpec
 
+        /**
+         * The instance finalization function (optional), should chain
+         *  up to the finalize method of the parent class.
+         */
         vfunc_finalize(): void;
+        /**
+         * Checks if contents of `value` comply with the specifications
+         *   set out by this type, without modifying the value. This vfunc is optional.
+         *   If it isn't set, GObject will use `value_validate`. Since 2.74
+         * @param value
+         */
         vfunc_value_is_valid(value: Value | any): boolean;
+        /**
+         * Resets a `value` to the default value for this type
+         *  (recommended, the default is g_value_reset()), see
+         *  g_param_value_set_default().
+         * @param value
+         */
         vfunc_value_set_default(value: Value | any): void;
+        /**
+         * Ensures that the contents of `value` comply with the
+         *  specifications set out by this type (optional), see
+         *  g_param_value_validate().
+         * @param value
+         */
         vfunc_value_validate(value: Value | any): boolean;
+        /**
+         * Compares `value1` with `value2` according to this type
+         *  (recommended, the default is memcmp()), see g_param_values_cmp().
+         * @param value1
+         * @param value2
+         */
         vfunc_values_cmp(value1: Value | any, value2: Value | any): number;
 
         // Own methods of GObject.ParamSpec
@@ -3875,7 +3948,14 @@ export namespace GObject {
 
         // Own virtual methods of GObject.TypeModule
 
+        /**
+         * loads the module and registers one or more types using
+         *  g_type_module_register_type().
+         */
         vfunc_load(): boolean;
+        /**
+         * unloads the module
+         */
         vfunc_unload(): void;
 
         // Own methods of GObject.TypeModule
@@ -4317,10 +4397,45 @@ export namespace GObject {
          * @param closure #GClosure to watch
          */
         watch_closure(closure: Closure): void;
+        /**
+         * the `constructed` function is called by g_object_new() as the
+         *  final step of the object creation process.  At the point of the call, all
+         *  construction properties have been set on the object.  The purpose of this
+         *  call is to allow for object initialisation steps that can only be performed
+         *  after construction properties have been set.  `constructed` implementors
+         *  should chain up to the `constructed` call of their parent class to allow it
+         *  to complete its initialisation.
+         */
         vfunc_constructed(): void;
+        /**
+         * emits property change notification for a bunch
+         *  of properties. Overriding `dispatch_properties_changed` should be rarely
+         *  needed.
+         * @param n_pspecs
+         * @param pspecs
+         */
         vfunc_dispatch_properties_changed(n_pspecs: number, pspecs: ParamSpec): void;
+        /**
+         * the `dispose` function is supposed to drop all references to other
+         *  objects, but keep the instance otherwise intact, so that client method
+         *  invocations still work. It may be run multiple times (due to reference
+         *  loops). Before returning, `dispose` should chain up to the `dispose` method
+         *  of the parent class.
+         */
         vfunc_dispose(): void;
+        /**
+         * instance finalization function, should finish the finalization of
+         *  the instance begun in `dispose` and chain up to the `finalize` method of the
+         *  parent class.
+         */
         vfunc_finalize(): void;
+        /**
+         * the generic getter for all properties of this type. Should be
+         *  overridden for every type with properties.
+         * @param property_id
+         * @param value
+         * @param pspec
+         */
         vfunc_get_property(property_id: number, value: Value | any, pspec: ParamSpec): void;
         /**
          * Emits a "notify" signal for the property `property_name` on `object`.
@@ -4336,6 +4451,16 @@ export namespace GObject {
          * @param pspec
          */
         vfunc_notify(pspec: ParamSpec): void;
+        /**
+         * the generic setter for all properties of this type. Should be
+         *  overridden for every type with properties. If implementations of
+         *  `set_property` don't emit property change notification explicitly, this will
+         *  be done implicitly by the type system. However, if the notify signal is
+         *  emitted explicitly, the type system will not emit it a second time.
+         * @param property_id
+         * @param value
+         * @param pspec
+         */
         vfunc_set_property(property_id: number, value: Value | any, pspec: ParamSpec): void;
         disconnect(id: number): void;
         set(properties: { [key: string]: any }): void;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@girs/gobject-2.0",
-  "version": "2.80.0-4.0.0-beta.4",
-  "description": "GJS TypeScript type definitions for GObject-2.0, generated from library version 2.80.0",
+  "version": "2.80.3-4.0.0-beta.6",
+  "description": "GJS TypeScript type definitions for GObject-2.0, generated from library version 2.80.3",
   "type": "module",
   "module": "gobject-2.0.js",
   "main": "gobject-2.0.js",
@@ -23,11 +23,11 @@
     }
   },
   "scripts": {
-    "test": "NODE_OPTIONS=--max_old_space_size=9216 tsc --noEmit gobject-2.0.d.ts"
+    "test": "tsc --project tsconfig.json"
   },
   "dependencies": {
-    "@girs/gjs": "^4.0.0-beta.4",
-    "@girs/glib-2.0": "^2.80.0-4.0.0-beta.4"
+    "@girs/gjs": "^4.0.0-beta.6",
+    "@girs/glib-2.0": "^2.80.3-4.0.0-beta.6"
   },
   "devDependencies": {
     "typescript": "*"