@girs/gobject-2.0 2.82.2-4.0.0-beta.19 → 2.82.4-4.0.0-beta.20

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.82.2 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0-beta.19.
+GJS TypeScript type definitions for GObject-2.0, generated from library version 2.82.4 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0-beta.20.
 
 
 ## Install

package/gobject-2.0.d.ts

@@ -2898,7 +2898,7 @@ export namespace GObject {
          */
         DEEP_DERIVABLE,
     }
-    module Binding {
+    namespace Binding {
         // Constructor properties interface
 
         interface ConstructorProps extends Object.ConstructorProps {
@@ -3124,7 +3124,7 @@ export namespace GObject {
         unbind(): void;
     }
 
-    module BindingGroup {
+    namespace BindingGroup {
         // Constructor properties interface
 
         interface ConstructorProps extends Object.ConstructorProps {
@@ -3239,7 +3239,7 @@ export namespace GObject {
         set_source(source?: Object | null): void;
     }
 
-    module InitiallyUnowned {
+    namespace InitiallyUnowned {
         // Constructor properties interface
 
         interface ConstructorProps extends Object.ConstructorProps {}
@@ -3261,7 +3261,7 @@ export namespace GObject {
         _init(...args: any[]): void;
     }
 
-    module Object {
+    namespace Object {
         // Signal callback interfaces
 
         interface Notify {
@@ -3794,18 +3794,8 @@ export namespace GObject {
     }
 
     /**
-     * `GParamSpec` encapsulates the metadata required to specify parameters, such as `GObject` properties.
-     *
-     * ## Parameter names
-     *
-     * A property name consists of one or more segments consisting of ASCII letters
-     * and digits, separated by either the `-` or `_` character. The first
-     * character of a property name must be a letter. These are the same rules as
-     * for signal naming (see [func`GObject`.signal_new]).
-     *
-     * When creating and looking up a `GParamSpec`, either separator can be
-     * used, but they cannot be mixed. Using `-` is considerably more
-     * efficient, and is the ‘canonical form’. Using `_` is discouraged.
+     * A GObject parameter specification that defines property characteristics.
+     * See https://gjs.guide/guides/gobject/basics.html#properties for more details.
      */
     abstract class ParamSpec<A = unknown> {
         static $gtype: GType<ParamSpec>;
@@ -3833,134 +3823,281 @@ export namespace GObject {
          * @param name the canonical name of the property
          */
         static is_valid_name(name: string): boolean;
+        /**
+         * Creates a new GParamSpecChar instance specifying a G_TYPE_CHAR property.
+         * @param name The name of the property
+         * @param nick A human readable name for the property
+         * @param blurb A longer description of the property
+         * @param flags The flags for this property (e.g. READABLE, WRITABLE)
+         * @param minimum The minimum value for this property
+         * @param maximum The maximum value for this property
+         * @param defaultValue The default value for this property
+         */
         static ['char'](
             name: string,
-            nick: string,
-            blurb: string,
+            nick: string | null,
+            blurb: string | null,
             flags: ParamFlags | number,
             minimum: number,
             maximum: number,
             defaultValue: number,
         ): ParamSpec<number>;
+        /**
+         * Creates a new GParamSpecUChar instance specifying a G_TYPE_UCHAR property.
+         * @param name The name of the property
+         * @param nick A human readable name for the property
+         * @param blurb A longer description of the property
+         * @param flags The flags for this property (e.g. READABLE, WRITABLE)
+         * @param minimum The minimum value for this property
+         * @param maximum The maximum value for this property
+         * @param defaultValue The default value for this property
+         */
         static uchar(
             name: string,
-            nick: string,
-            blurb: string,
+            nick: string | null,
+            blurb: string | null,
             flags: ParamFlags | number,
             minimum: number,
             maximum: number,
             defaultValue: number,
         ): ParamSpec<number>;
+        /**
+         * Creates a new GParamSpecInt instance specifying a G_TYPE_INT property.
+         * @param name The name of the property
+         * @param nick A human readable name for the property
+         * @param blurb A longer description of the property
+         * @param flags The flags for this property (e.g. READABLE, WRITABLE)
+         * @param minimum The minimum value for this property
+         * @param maximum The maximum value for this property
+         * @param defaultValue The default value for this property
+         */
         static int(
             name: string,
-            nick: string,
-            blurb: string,
+            nick: string | null,
+            blurb: string | null,
             flags: ParamFlags | number,
             minimum: number,
             maximum: number,
             defaultValue: number,
         ): ParamSpec<number>;
+        /**
+         * Creates a new GParamSpecUInt instance specifying a G_TYPE_UINT property.
+         * @param name The name of the property
+         * @param nick A human readable name for the property
+         * @param blurb A longer description of the property
+         * @param flags The flags for this property (e.g. READABLE, WRITABLE)
+         * @param minimum The minimum value for this property
+         * @param maximum The maximum value for this property
+         * @param defaultValue The default value for this property
+         */
         static uint(
             name: string,
-            nick: string,
-            blurb: string,
+            nick: string | null,
+            blurb: string | null,
             flags: ParamFlags | number,
             minimum: number,
             maximum: number,
             defaultValue: number,
         ): ParamSpec<number>;
+        /**
+         * Creates a new GParamSpecLong instance specifying a G_TYPE_LONG property.
+         * @param name The name of the property
+         * @param nick A human readable name for the property
+         * @param blurb A longer description of the property
+         * @param flags The flags for this property (e.g. READABLE, WRITABLE)
+         * @param minimum The minimum value for this property
+         * @param maximum The maximum value for this property
+         * @param defaultValue The default value for this property
+         */
         static long(
             name: string,
-            nick: string,
-            blurb: string,
+            nick: string | null,
+            blurb: string | null,
             flags: ParamFlags | number,
             minimum: number,
             maximum: number,
             defaultValue: number,
         ): ParamSpec<number>;
+        /**
+         * Creates a new GParamSpecULong instance specifying a G_TYPE_ULONG property.
+         * @param name The name of the property
+         * @param nick A human readable name for the property
+         * @param blurb A longer description of the property
+         * @param flags The flags for this property (e.g. READABLE, WRITABLE)
+         * @param minimum The minimum value for this property
+         * @param maximum The maximum value for this property
+         * @param defaultValue The default value for this property
+         */
         static ulong(
             name: string,
-            nick: string,
-            blurb: string,
+            nick: string | null,
+            blurb: string | null,
             flags: ParamFlags | number,
             minimum: number,
             maximum: number,
             defaultValue: number,
         ): ParamSpec<number>;
+        /**
+         * Creates a new GParamSpecInt64 instance specifying a G_TYPE_INT64 property.
+         * @param name The name of the property
+         * @param nick A human readable name for the property
+         * @param blurb A longer description of the property
+         * @param flags The flags for this property (e.g. READABLE, WRITABLE)
+         * @param minimum The minimum value for this property
+         * @param maximum The maximum value for this property
+         * @param defaultValue The default value for this property
+         */
         static int64(
             name: string,
-            nick: string,
-            blurb: string,
+            nick: string | null,
+            blurb: string | null,
             flags: ParamFlags | number,
             minimum: number,
             maximum: number,
             defaultValue: number,
         ): ParamSpec<number>;
+        /**
+         * Creates a new GParamSpecUInt64 instance specifying a G_TYPE_UINT64 property.
+         * @param name The name of the property
+         * @param nick A human readable name for the property
+         * @param blurb A longer description of the property
+         * @param flags The flags for this property (e.g. READABLE, WRITABLE)
+         * @param minimum The minimum value for this property
+         * @param maximum The maximum value for this property
+         * @param defaultValue The default value for this property
+         */
         static uint64(
             name: string,
-            nick: string,
-            blurb: string,
+            nick: string | null,
+            blurb: string | null,
             flags: ParamFlags | number,
             minimum: number,
             maximum: number,
             defaultValue: number,
         ): ParamSpec<number>;
+        /**
+         * Creates a new GParamSpecFloat instance specifying a G_TYPE_FLOAT property.
+         * @param name The name of the property
+         * @param nick A human readable name for the property
+         * @param blurb A longer description of the property
+         * @param flags The flags for this property (e.g. READABLE, WRITABLE)
+         * @param minimum The minimum value for this property
+         * @param maximum The maximum value for this property
+         * @param defaultValue The default value for this property
+         */
         static float(
             name: string,
-            nick: string,
-            blurb: string,
+            nick: string | null,
+            blurb: string | null,
             flags: ParamFlags | number,
             minimum: number,
             maximum: number,
             defaultValue: number,
         ): ParamSpec<number>;
+        /**
+         * Creates a new GParamSpecBoolean instance specifying a G_TYPE_BOOLEAN property. In many cases, it may be more appropriate to use an enum with g_param_spec_enum(), both to improve code clarity by using explicitly named values, and to allow for more values to be added in future without breaking API.
+         * @param name The name of the property
+         * @param nick A human readable name for the property
+         * @param blurb A longer description of the property
+         * @param flags The flags for this property (e.g. READABLE, WRITABLE)
+         * @param defaultValue The default value for this property
+         */
         static ['boolean'](
             name: string,
-            nick: string,
-            blurb: string,
+            nick: string | null,
+            blurb: string | null,
             flags: ParamFlags | number,
             defaultValue: boolean,
         ): ParamSpec<boolean>;
+        /**
+         * Creates a new GParamSpecEnum instance specifying a G_TYPE_ENUM property.
+         * @param name The name of the property
+         * @param nick A human readable name for the property
+         * @param blurb A longer description of the property
+         * @param flags The flags for this property (e.g. READABLE, WRITABLE)
+         * @param enumType
+         * @param defaultValue The default value for this property
+         */
         static ['enum']<T>(
             name: string,
-            nick: string,
-            blurb: string,
+            nick: string | null,
+            blurb: string | null,
             flags: ParamFlags | number,
             enumType: GType<T> | { $gtype: GType<T> },
             defaultValue: any,
         ): ParamSpec<T>;
+        /**
+         * Creates a new GParamSpecDouble instance specifying a G_TYPE_DOUBLE property.
+         * @param name The name of the property
+         * @param nick A human readable name for the property
+         * @param blurb A longer description of the property
+         * @param flags The flags for this property (e.g. READABLE, WRITABLE)
+         * @param minimum The minimum value for this property
+         * @param maximum The maximum value for this property
+         * @param defaultValue The default value for this property
+         */
         static double(
             name: string,
-            nick: string,
-            blurb: string,
+            nick: string | null,
+            blurb: string | null,
             flags: ParamFlags | number,
             minimum: number,
             maximum: number,
             defaultValue: number,
         ): ParamSpec<number>;
+        /**
+         * Creates a new GParamSpecString instance specifying a G_TYPE_STRING property.
+         * @param name The name of the property
+         * @param nick A human readable name for the property
+         * @param blurb A longer description of the property
+         * @param flags The flags for this property (e.g. READABLE, WRITABLE)
+         * @param defaultValue The default value for this property
+         */
         static string(
             name: string,
-            nick: string,
-            blurb: string,
+            nick: string | null,
+            blurb: string | null,
             flags: ParamFlags | number,
             defaultValue: string,
         ): ParamSpec<string>;
+        /**
+         * Creates a new GParamSpecBoxed instance specifying a G_TYPE_BOXED derived property.
+         * @param name The name of the property
+         * @param nick A human readable name for the property
+         * @param blurb A longer description of the property
+         * @param flags The flags for this property (e.g. READABLE, WRITABLE)
+         * @param boxedType
+         */
         static boxed<T>(
             name: string,
-            nick: string,
-            blurb: string,
+            nick: string | null,
+            blurb: string | null,
             flags: ParamFlags | number,
             boxedType: GType<T> | { $gtype: GType<T> },
         ): ParamSpec<T>;
         static object<T>(
             name: string,
-            nick: string,
-            blurb: string,
+            nick: string | null,
+            blurb: string | null,
             flags: string,
             objectType: GType<T> | { $gtype: GType<T> },
         ): ParamSpec<T>;
-        static param(name: string, nick: string, blurb: string, flags: ParamFlags | number, paramType: any): ParamSpec;
-        static jsobject<T>(name: string, nick: string, blurb: string, flags: any): ParamSpec<T>;
+        /**
+         * Creates a new GParamSpecParam instance specifying a G_TYPE_PARAM property.
+         * @param name The name of the property
+         * @param nick A human readable name for the property
+         * @param blurb A longer description of the property
+         * @param flags The flags for this property (e.g. READABLE, WRITABLE)
+         * @param paramType
+         */
+        static param(
+            name: string,
+            nick: string | null,
+            blurb: string | null,
+            flags: ParamFlags | number,
+            paramType: any,
+        ): ParamSpec;
+        static jsobject<T>(name: string, nick: string | null, blurb: string | null, flags: any): ParamSpec<T>;
 
         // Virtual methods
 
@@ -4080,7 +4217,7 @@ export namespace GObject {
         override(name: string, oclass: Object | Function | GType): void;
     }
 
-    module SignalGroup {
+    namespace SignalGroup {
         // Signal callback interfaces
 
         interface Bind {
@@ -4231,7 +4368,7 @@ export namespace GObject {
         unblock(): void;
     }
 
-    module TypeModule {
+    namespace TypeModule {
         // Constructor properties interface
 
         interface ConstructorProps extends Object.ConstructorProps, TypePlugin.ConstructorProps {}
@@ -6473,7 +6610,7 @@ export namespace GObject {
         _init(...args: any[]): void;
     }
 
-    module TypePlugin {
+    namespace TypePlugin {
         // Constructor properties interface
 
         interface ConstructorProps extends Object.ConstructorProps {}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@girs/gobject-2.0",
-  "version": "2.82.2-4.0.0-beta.19",
-  "description": "GJS TypeScript type definitions for GObject-2.0, generated from library version 2.82.2",
+  "version": "2.82.4-4.0.0-beta.20",
+  "description": "GJS TypeScript type definitions for GObject-2.0, generated from library version 2.82.4",
   "type": "module",
   "module": "gobject-2.0.js",
   "main": "gobject-2.0.js",
@@ -31,8 +31,8 @@
     "test": "tsc --project tsconfig.json"
   },
   "dependencies": {
-    "@girs/gjs": "^4.0.0-beta.19",
-    "@girs/glib-2.0": "^2.82.2-4.0.0-beta.19"
+    "@girs/gjs": "^4.0.0-beta.20",
+    "@girs/glib-2.0": "^2.82.4-4.0.0-beta.20"
   },
   "devDependencies": {
     "typescript": "*"