@girs/geocodeglib-2.0 2.0.0-4.0.0-beta.5 → 2.0.0-4.0.0-beta.7

package/README.md

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

package/geocodeglib-2.0-ambient.d.ts

@@ -1,12 +1,9 @@
-
 declare module 'gi://GeocodeGlib?version=2.0' {
-    import GeocodeGlib from '@girs/geocodeglib-2.0';
-    export default GeocodeGlib;
+    import GeocodeGlib20 from '@girs/geocodeglib-2.0';
+    export default GeocodeGlib20;
 }
 
 declare module 'gi://GeocodeGlib' {
     import GeocodeGlib20 from 'gi://GeocodeGlib?version=2.0';
     export default GeocodeGlib20;
 }
-
-

package/geocodeglib-2.0-import.d.ts

@@ -1,4 +1,3 @@
-
 import GeocodeGlib20 from '@girs/geocodeglib-2.0';
 
 declare global {
@@ -8,5 +7,3 @@ declare global {
 }
 
 export default GjsGiImports;
-
-

package/geocodeglib-2.0.d.ts

@@ -1,23 +1,25 @@
-/*
+/**
  * Type Definitions for Gjs (https://gjs.guide/)
  *
  * These type definitions are automatically generated, do not edit them by hand.
  * If you found a bug fix it in `ts-for-gir` or create a bug report on https://github.com/gjsify/ts-for-gir
+ *
+ * The based EJS template file is used for the generated .d.ts file of each GIR module like Gtk-4.0, GObject-2.0, ...
  */
 
-import './geocodeglib-2.0-ambient.d.ts';
-
-/**
- * GeocodeGlib-2.0
- */
-
+// Module dependencies
 import type Soup from '@girs/soup-3.0';
 import type Gio from '@girs/gio-2.0';
 import type GObject from '@girs/gobject-2.0';
 import type GLib from '@girs/glib-2.0';
+import type GModule from '@girs/gmodule-2.0';
 import type Json from '@girs/json-1.0';
 
 export namespace GeocodeGlib {
+    /**
+     * GeocodeGlib-2.0
+     */
+
     /**
      * Error codes returned by geocode-glib functions.
      */
@@ -1107,7 +1109,7 @@ export namespace GeocodeGlib {
          *   static void
          *   my_object_class_init (MyObjectClass *klass)
          *   {
-         *     properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
+         *     properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
          *                                              0, 100,
          *                                              50,
          *                                              G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
@@ -1260,10 +1262,45 @@ export namespace GeocodeGlib {
          * @param closure #GClosure to watch
          */
         watch_closure(closure: GObject.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: GObject.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: GObject.Value | any, pspec: GObject.ParamSpec): void;
         /**
          * Emits a "notify" signal for the property `property_name` on `object`.
@@ -1279,6 +1316,16 @@ export namespace GeocodeGlib {
          * @param pspec
          */
         vfunc_notify(pspec: GObject.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: GObject.Value | any, pspec: GObject.ParamSpec): void;
         disconnect(id: number): void;
         set(properties: { [key: string]: any }): void;
@@ -1381,12 +1428,27 @@ export namespace GeocodeGlib {
 
         // Own virtual methods of GeocodeGlib.Nominatim
 
+        /**
+         * synchronous query function to override network `GET` requests.
+         * @param uri
+         * @param cancellable
+         */
         vfunc_query(uri: string, cancellable?: Gio.Cancellable | null): string;
+        /**
+         * asynchronous version of `query`.
+         * @param uri
+         * @param cancellable
+         * @param callback
+         */
         vfunc_query_async(
             uri: string,
             cancellable?: Gio.Cancellable | null,
             callback?: Gio.AsyncReadyCallback<this> | null,
         ): void;
+        /**
+         * asynchronous finish function for `query_async`.
+         * @param res
+         */
         vfunc_query_finish(res: Gio.AsyncResult): string;
 
         // Inherited methods
@@ -1757,7 +1819,7 @@ export namespace GeocodeGlib {
          *   static void
          *   my_object_class_init (MyObjectClass *klass)
          *   {
-         *     properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
+         *     properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
          *                                              0, 100,
          *                                              50,
          *                                              G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
@@ -1910,10 +1972,45 @@ export namespace GeocodeGlib {
          * @param closure #GClosure to watch
          */
         watch_closure(closure: GObject.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: GObject.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: GObject.Value | any, pspec: GObject.ParamSpec): void;
         /**
          * Emits a "notify" signal for the property `property_name` on `object`.
@@ -1929,6 +2026,16 @@ export namespace GeocodeGlib {
          * @param pspec
          */
         vfunc_notify(pspec: GObject.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: GObject.Value | any, pspec: GObject.ParamSpec): void;
         disconnect(id: number): void;
         set(properties: { [key: string]: any }): void;
@@ -2662,4 +2769,5 @@ export namespace GeocodeGlib {
 }
 
 export default GeocodeGlib;
+
 // END

package/geocodeglib-2.0.js

@@ -1,6 +1,5 @@
 
-  // @ts-expect-error
-  import GeocodeGlib from 'gi://GeocodeGlib?version=2.0';
-  export { GeocodeGlib };
-  export default GeocodeGlib;
+// @ts-expect-error
+import GeocodeGlib from 'gi://GeocodeGlib?version=2.0';
+export default GeocodeGlib;
 

package/index.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Type Definitions for Gjs (https://gjs.guide/)
+ *
+ * These type definitions are automatically generated, do not edit them by hand.
+ * If you found a bug fix it in `ts-for-gir` or create a bug report on https://github.com/gjsify/ts-for-gir
+ *
+ * This template is used to generate the index.d.ts file of each GIR module like Gtk-4.0, GObject-2.0, ...
+ */
+
+import './geocodeglib-2.0-ambient.d.ts';
+
+import './geocodeglib-2.0-import.d.ts';
+
+import GeocodeGlib from './geocodeglib-2.0.js';
+export default GeocodeGlib;

package/index.js

@@ -0,0 +1,5 @@
+
+// @ts-expect-error
+import GeocodeGlib from './geocodeglib-2.0.js';
+export default GeocodeGlib;
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@girs/geocodeglib-2.0",
-  "version": "2.0.0-4.0.0-beta.5",
+  "version": "2.0.0-4.0.0-beta.7",
   "description": "GJS TypeScript type definitions for GeocodeGlib-2.0, generated from library version 2.0.0",
   "type": "module",
   "module": "geocodeglib-2.0.js",
@@ -16,22 +16,28 @@
       "import": "./geocodeglib-2.0-import.js",
       "default": "./geocodeglib-2.0-import.js"
     },
-    ".": {
+    "./geocodeglib-2.0": {
       "types": "./geocodeglib-2.0.d.ts",
       "import": "./geocodeglib-2.0.js",
       "default": "./geocodeglib-2.0.js"
+    },
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.js",
+      "default": "./index.js"
     }
   },
   "scripts": {
-    "test": "NODE_OPTIONS=--max_old_space_size=9216 tsc --noEmit geocodeglib-2.0.d.ts"
+    "test": "tsc --project tsconfig.json"
   },
   "dependencies": {
-    "@girs/gio-2.0": "^2.80.0-4.0.0-beta.5",
-    "@girs/gjs": "^4.0.0-beta.5",
-    "@girs/glib-2.0": "^2.80.0-4.0.0-beta.5",
-    "@girs/gobject-2.0": "^2.80.0-4.0.0-beta.5",
-    "@girs/json-1.0": "^1.8.0-4.0.0-beta.5",
-    "@girs/soup-3.0": "^3.4.4-4.0.0-beta.5"
+    "@girs/gio-2.0": "^2.80.2-4.0.0-beta.7",
+    "@girs/gjs": "^4.0.0-beta.7",
+    "@girs/glib-2.0": "^2.80.2-4.0.0-beta.7",
+    "@girs/gmodule-2.0": "^2.0.0-4.0.0-beta.7",
+    "@girs/gobject-2.0": "^2.80.2-4.0.0-beta.7",
+    "@girs/json-1.0": "^1.8.0-4.0.0-beta.7",
+    "@girs/soup-3.0": "^3.4.4-4.0.0-beta.7"
   },
   "devDependencies": {
     "typescript": "*"

package/tsconfig.json

@@ -2,11 +2,11 @@
   "compilerOptions": {
     // General settings for code interpretation
     "target": "ESNext",
-    "module": "ESNext",
+    "module": "NodeNext",
     "lib": ["ESNext"],
     "types": [],
     "experimentalDecorators": true,
-    "moduleResolution": "node",
+    "moduleResolution": "NodeNext",
     "noEmit": true,
     "noEmitOnError": false,
     "baseUrl": "./",