@girs/peas-2 2.0.0-3.2.5 → 2.0.0-3.2.7

package/README.md

@@ -5,7 +5,7 @@
 ![downloads/week](https://img.shields.io/npm/dw/@girs/peas-2)
 
 
-GJS TypeScript type definitions for Peas-2, generated from library version 2.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.2.5.
+GJS TypeScript type definitions for Peas-2, generated from library version 2.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.2.7.
 
 
 ## Install

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@girs/peas-2",
-  "version": "2.0.0-3.2.5",
+  "version": "2.0.0-3.2.7",
   "description": "GJS TypeScript type definitions for Peas-2, generated from library version 2.0.0",
   "type": "module",
   "module": "peas-2.js",
@@ -25,11 +25,11 @@
     "test:cjs": "NODE_OPTIONS=--max_old_space_size=9216 tsc --noEmit peas-2.d.cts"
   },
   "dependencies": {
-    "@girs/gio-2.0": "^2.78.0-3.2.5",
-    "@girs/gjs": "^3.2.5",
-    "@girs/glib-2.0": "^2.78.0-3.2.5",
-    "@girs/gmodule-2.0": "^2.0.0-3.2.5",
-    "@girs/gobject-2.0": "^2.78.0-3.2.5"
+    "@girs/gio-2.0": "^2.78.0-3.2.7",
+    "@girs/gjs": "^3.2.7",
+    "@girs/glib-2.0": "^2.78.0-3.2.7",
+    "@girs/gmodule-2.0": "^2.0.0-3.2.7",
+    "@girs/gobject-2.0": "^2.78.0-3.2.7"
   },
   "devDependencies": {
     "typescript": "*"

package/peas-2.d.cts

@@ -114,6 +114,32 @@ export module Engine {
          * See [ctor`Engine`.new_with_nonglobal_loaders] for more information.
          */
         nonglobal_loaders?: boolean | null
+        /**
+         * The list of loaded plugins.
+         * 
+         * This will be modified when [method`Engine`.load_plugin] or
+         * [method`Engine`.unload_plugin] is called.
+         * 
+         * This can be used with [class`Gio`.Settings] to save the loaded plugins by
+         * binding to this property after instantiating the engine by doing:
+         * 
+         * ```c
+         *   g_settings_bind (gsettings_object,
+         *                    LOADED_PLUGINS_KEY,
+         *                    engine,
+         *                    "loaded-plugins",
+         *                    G_SETTINGS_BIND_DEFAULT);
+         * ```
+         * 
+         * Note: notify will not be called when the engine is being destroyed.
+         */
+        loadedPlugins?: string[] | null
+        /**
+         * If non-global plugin loaders should be used.
+         * 
+         * See [ctor`Engine`.new_with_nonglobal_loaders] for more information.
+         */
+        nonglobalLoaders?: boolean | null
     }
 
 }
@@ -142,12 +168,38 @@ export interface Engine extends Gio.ListModel {
      * Note: notify will not be called when the engine is being destroyed.
      */
     loaded_plugins: string[]
+    /**
+     * The list of loaded plugins.
+     * 
+     * This will be modified when [method`Engine`.load_plugin] or
+     * [method`Engine`.unload_plugin] is called.
+     * 
+     * This can be used with [class`Gio`.Settings] to save the loaded plugins by
+     * binding to this property after instantiating the engine by doing:
+     * 
+     * ```c
+     *   g_settings_bind (gsettings_object,
+     *                    LOADED_PLUGINS_KEY,
+     *                    engine,
+     *                    "loaded-plugins",
+     *                    G_SETTINGS_BIND_DEFAULT);
+     * ```
+     * 
+     * Note: notify will not be called when the engine is being destroyed.
+     */
+    loadedPlugins: string[]
     /**
      * If non-global plugin loaders should be used.
      * 
      * See [ctor`Engine`.new_with_nonglobal_loaders] for more information.
      */
     readonly nonglobal_loaders: boolean
+    /**
+     * If non-global plugin loaders should be used.
+     * 
+     * See [ctor`Engine`.new_with_nonglobal_loaders] for more information.
+     */
+    readonly nonglobalLoaders: boolean
 
     // Owm methods of Peas-2.Peas.Engine
 
@@ -170,7 +222,7 @@ export interface Engine extends Gio.ListModel {
      * @param module_dir the plugin module directory.
      * @param data_dir the plugin data directory.
      */
-    add_search_path(module_dir: string | null, data_dir: string | null): void
+    add_search_path(module_dir: string, data_dir: string | null): void
     /**
      * If the plugin identified by `info` implements the `extension_type,`
      * then this function will return a new instance of this implementation.
@@ -213,7 +265,7 @@ export interface Engine extends Gio.ListModel {
      *   however a warning has been added to help applications transition.
      * @param loader_name The name of the loader to enable.
      */
-    enable_loader(loader_name: string | null): void
+    enable_loader(loader_name: string): void
     /**
      * Triggers garbage collection on all the loaders currently owned by the
      * #PeasEngine.
@@ -229,7 +281,7 @@ export interface Engine extends Gio.ListModel {
      * @param plugin_name A plugin name.
      * @returns the #PeasPluginInfo corresponding with   a given plugin module name.
      */
-    get_plugin_info(plugin_name: string | null): PluginInfo
+    get_plugin_info(plugin_name: string): PluginInfo
     /**
      * Loads the plugin corresponding to `info` if it's not currently loaded.
      * 
@@ -380,6 +432,10 @@ export module ExtensionBase {
          * The [class`PluginInfo]` related to the current plugin.
          */
         plugin_info?: PluginInfo | null
+        /**
+         * The [class`PluginInfo]` related to the current plugin.
+         */
+        pluginInfo?: PluginInfo | null
     }
 
 }
@@ -396,10 +452,22 @@ export interface ExtensionBase {
      * [method`PluginInfo`.get_data_dir].
      */
     readonly data_dir: string | null
+    /**
+     * The The full path of the directory where the plugin
+     * should look for its data files.
+     * 
+     * Note: This is the same path as that returned by
+     * [method`PluginInfo`.get_data_dir].
+     */
+    readonly dataDir: string | null
     /**
      * The [class`PluginInfo]` related to the current plugin.
      */
     readonly plugin_info: PluginInfo
+    /**
+     * The [class`PluginInfo]` related to the current plugin.
+     */
+    readonly pluginInfo: PluginInfo
 
     // Own fields of Peas-2.Peas.ExtensionBase
 
@@ -487,6 +555,8 @@ export module ExtensionSet {
         construct_properties?: any | null
         engine?: Engine | null
         extension_type?: GObject.GType | null
+        constructProperties?: any | null
+        extensionType?: GObject.GType | null
     }
 
 }
@@ -496,8 +566,10 @@ export interface ExtensionSet extends Gio.ListModel {
     // Own properties of Peas-2.Peas.ExtensionSet
 
     readonly construct_properties: any
+    readonly constructProperties: any
     readonly engine: Engine
     readonly extension_type: GObject.GType
+    readonly extensionType: GObject.GType
 
     // Owm methods of Peas-2.Peas.ExtensionSet
 
@@ -652,6 +724,11 @@ export module ObjectModule {
         path?: string | null
         resident?: boolean | null
         symbol?: string | null
+        /**
+         * Whether the module is loaded with local linkage, i.e. #G_MODULE_BIND_LOCAL.
+         */
+        localLinkage?: boolean | null
+        moduleName?: string | null
     }
 
 }
@@ -664,7 +741,12 @@ export interface ObjectModule extends GObject.TypePlugin {
      * Whether the module is loaded with local linkage, i.e. #G_MODULE_BIND_LOCAL.
      */
     readonly local_linkage: boolean
+    /**
+     * Whether the module is loaded with local linkage, i.e. #G_MODULE_BIND_LOCAL.
+     */
+    readonly localLinkage: boolean
     readonly module_name: string | null
+    readonly moduleName: string | null
     readonly path: string | null
     readonly resident: boolean
     readonly symbol: string | null
@@ -785,11 +867,15 @@ export interface PluginInfo {
     readonly dependencies: string[]
     readonly description: string | null
     readonly help_uri: string | null
+    readonly helpUri: string | null
     readonly hidden: boolean
     readonly icon_name: string | null
+    readonly iconName: string | null
     readonly loaded: boolean
     readonly module_dir: string | null
+    readonly moduleDir: string | null
     readonly module_name: string | null
+    readonly moduleName: string | null
     readonly name: string | null
     readonly version: string | null
     readonly website: string | null
@@ -809,7 +895,7 @@ export interface PluginInfo {
      * The relevant key in the plugin info file is "Copyright".
      * @returns the plugin's copyright information.
      */
-    get_copyright(): string | null
+    get_copyright(): string
     /**
      * Gets the data dir of the plugin.
      * 
@@ -819,7 +905,7 @@ export interface PluginInfo {
      * file was found.
      * @returns the plugin's data dir.
      */
-    get_data_dir(): string | null
+    get_data_dir(): string
     /**
      * Gets the dependencies of the plugin.
      * 
@@ -841,7 +927,7 @@ export interface PluginInfo {
      * The relevant key in the plugin info file is "Description".
      * @returns the plugin's description.
      */
-    get_description(): string | null
+    get_description(): string
     /**
      * Gets external data specified for the plugin.
      * 
@@ -854,7 +940,7 @@ export interface PluginInfo {
      * @param key The key to lookup.
      * @returns the external data, or %NULL if the external data could not be found.
      */
-    get_external_data(key: string | null): string | null
+    get_external_data(key: string): string | null
     /**
      * Gets the help URI of the plugin.
      * 
@@ -867,7 +953,7 @@ export interface PluginInfo {
      * "Help-Windows" and "Help-MacOS-X".
      * @returns the plugin's help URI.
      */
-    get_help_uri(): string | null
+    get_help_uri(): string
     /**
      * Gets the icon name of the plugin.
      * 
@@ -877,7 +963,7 @@ export interface PluginInfo {
      * The relevant key in the plugin info file is "Icon".
      * @returns the plugin's icon name.
      */
-    get_icon_name(): string | null
+    get_icon_name(): string
     /**
      * Gets the module directory.
      * 
@@ -886,7 +972,7 @@ export interface PluginInfo {
      * [class`Engine]`.
      * @returns the module directory.
      */
-    get_module_dir(): string | null
+    get_module_dir(): string
     /**
      * Gets the module name.
      * 
@@ -897,7 +983,7 @@ export interface PluginInfo {
      * The relevant key in the plugin info file is "Module".
      * @returns the module name.
      */
-    get_module_name(): string | null
+    get_module_name(): string
     /**
      * Gets the name of the plugin.
      * 
@@ -906,7 +992,7 @@ export interface PluginInfo {
      * The relevant key in the plugin info file is "Name".
      * @returns the plugin's name.
      */
-    get_name(): string | null
+    get_name(): string
     /**
      * Creates a new #GResource for the given `filename`
      * located in the module directory. If `filename` is %NULL
@@ -929,20 +1015,20 @@ export interface PluginInfo {
      * The relevant key in the plugin info file is "Version".
      * @returns the plugin's version.
      */
-    get_version(): string | null
+    get_version(): string
     /**
      * Gets the website of the plugin.
      * 
      * The relevant key in the plugin info file is "Website".
      * @returns the plugin's associated website.
      */
-    get_website(): string | null
+    get_website(): string
     /**
      * Check if the plugin depends on another plugin.
      * @param module_name The name of the plugin to check.
      * @returns whether the plugin depends on the plugin @module_name.
      */
-    has_dependency(module_name: string | null): boolean
+    has_dependency(module_name: string): boolean
     /**
      * Check if the plugin is available.
      * 

package/peas-2.d.ts

@@ -116,6 +116,32 @@ module Engine {
          * See [ctor`Engine`.new_with_nonglobal_loaders] for more information.
          */
         nonglobal_loaders?: boolean | null
+        /**
+         * The list of loaded plugins.
+         * 
+         * This will be modified when [method`Engine`.load_plugin] or
+         * [method`Engine`.unload_plugin] is called.
+         * 
+         * This can be used with [class`Gio`.Settings] to save the loaded plugins by
+         * binding to this property after instantiating the engine by doing:
+         * 
+         * ```c
+         *   g_settings_bind (gsettings_object,
+         *                    LOADED_PLUGINS_KEY,
+         *                    engine,
+         *                    "loaded-plugins",
+         *                    G_SETTINGS_BIND_DEFAULT);
+         * ```
+         * 
+         * Note: notify will not be called when the engine is being destroyed.
+         */
+        loadedPlugins?: string[] | null
+        /**
+         * If non-global plugin loaders should be used.
+         * 
+         * See [ctor`Engine`.new_with_nonglobal_loaders] for more information.
+         */
+        nonglobalLoaders?: boolean | null
     }
 
 }
@@ -144,12 +170,38 @@ interface Engine extends Gio.ListModel {
      * Note: notify will not be called when the engine is being destroyed.
      */
     loaded_plugins: string[]
+    /**
+     * The list of loaded plugins.
+     * 
+     * This will be modified when [method`Engine`.load_plugin] or
+     * [method`Engine`.unload_plugin] is called.
+     * 
+     * This can be used with [class`Gio`.Settings] to save the loaded plugins by
+     * binding to this property after instantiating the engine by doing:
+     * 
+     * ```c
+     *   g_settings_bind (gsettings_object,
+     *                    LOADED_PLUGINS_KEY,
+     *                    engine,
+     *                    "loaded-plugins",
+     *                    G_SETTINGS_BIND_DEFAULT);
+     * ```
+     * 
+     * Note: notify will not be called when the engine is being destroyed.
+     */
+    loadedPlugins: string[]
     /**
      * If non-global plugin loaders should be used.
      * 
      * See [ctor`Engine`.new_with_nonglobal_loaders] for more information.
      */
     readonly nonglobal_loaders: boolean
+    /**
+     * If non-global plugin loaders should be used.
+     * 
+     * See [ctor`Engine`.new_with_nonglobal_loaders] for more information.
+     */
+    readonly nonglobalLoaders: boolean
 
     // Owm methods of Peas-2.Peas.Engine
 
@@ -172,7 +224,7 @@ interface Engine extends Gio.ListModel {
      * @param module_dir the plugin module directory.
      * @param data_dir the plugin data directory.
      */
-    add_search_path(module_dir: string | null, data_dir: string | null): void
+    add_search_path(module_dir: string, data_dir: string | null): void
     /**
      * If the plugin identified by `info` implements the `extension_type,`
      * then this function will return a new instance of this implementation.
@@ -215,7 +267,7 @@ interface Engine extends Gio.ListModel {
      *   however a warning has been added to help applications transition.
      * @param loader_name The name of the loader to enable.
      */
-    enable_loader(loader_name: string | null): void
+    enable_loader(loader_name: string): void
     /**
      * Triggers garbage collection on all the loaders currently owned by the
      * #PeasEngine.
@@ -231,7 +283,7 @@ interface Engine extends Gio.ListModel {
      * @param plugin_name A plugin name.
      * @returns the #PeasPluginInfo corresponding with   a given plugin module name.
      */
-    get_plugin_info(plugin_name: string | null): PluginInfo
+    get_plugin_info(plugin_name: string): PluginInfo
     /**
      * Loads the plugin corresponding to `info` if it's not currently loaded.
      * 
@@ -382,6 +434,10 @@ module ExtensionBase {
          * The [class`PluginInfo]` related to the current plugin.
          */
         plugin_info?: PluginInfo | null
+        /**
+         * The [class`PluginInfo]` related to the current plugin.
+         */
+        pluginInfo?: PluginInfo | null
     }
 
 }
@@ -398,10 +454,22 @@ interface ExtensionBase {
      * [method`PluginInfo`.get_data_dir].
      */
     readonly data_dir: string | null
+    /**
+     * The The full path of the directory where the plugin
+     * should look for its data files.
+     * 
+     * Note: This is the same path as that returned by
+     * [method`PluginInfo`.get_data_dir].
+     */
+    readonly dataDir: string | null
     /**
      * The [class`PluginInfo]` related to the current plugin.
      */
     readonly plugin_info: PluginInfo
+    /**
+     * The [class`PluginInfo]` related to the current plugin.
+     */
+    readonly pluginInfo: PluginInfo
 
     // Own fields of Peas-2.Peas.ExtensionBase
 
@@ -489,6 +557,8 @@ module ExtensionSet {
         construct_properties?: any | null
         engine?: Engine | null
         extension_type?: GObject.GType | null
+        constructProperties?: any | null
+        extensionType?: GObject.GType | null
     }
 
 }
@@ -498,8 +568,10 @@ interface ExtensionSet extends Gio.ListModel {
     // Own properties of Peas-2.Peas.ExtensionSet
 
     readonly construct_properties: any
+    readonly constructProperties: any
     readonly engine: Engine
     readonly extension_type: GObject.GType
+    readonly extensionType: GObject.GType
 
     // Owm methods of Peas-2.Peas.ExtensionSet
 
@@ -654,6 +726,11 @@ module ObjectModule {
         path?: string | null
         resident?: boolean | null
         symbol?: string | null
+        /**
+         * Whether the module is loaded with local linkage, i.e. #G_MODULE_BIND_LOCAL.
+         */
+        localLinkage?: boolean | null
+        moduleName?: string | null
     }
 
 }
@@ -666,7 +743,12 @@ interface ObjectModule extends GObject.TypePlugin {
      * Whether the module is loaded with local linkage, i.e. #G_MODULE_BIND_LOCAL.
      */
     readonly local_linkage: boolean
+    /**
+     * Whether the module is loaded with local linkage, i.e. #G_MODULE_BIND_LOCAL.
+     */
+    readonly localLinkage: boolean
     readonly module_name: string | null
+    readonly moduleName: string | null
     readonly path: string | null
     readonly resident: boolean
     readonly symbol: string | null
@@ -787,11 +869,15 @@ interface PluginInfo {
     readonly dependencies: string[]
     readonly description: string | null
     readonly help_uri: string | null
+    readonly helpUri: string | null
     readonly hidden: boolean
     readonly icon_name: string | null
+    readonly iconName: string | null
     readonly loaded: boolean
     readonly module_dir: string | null
+    readonly moduleDir: string | null
     readonly module_name: string | null
+    readonly moduleName: string | null
     readonly name: string | null
     readonly version: string | null
     readonly website: string | null
@@ -811,7 +897,7 @@ interface PluginInfo {
      * The relevant key in the plugin info file is "Copyright".
      * @returns the plugin's copyright information.
      */
-    get_copyright(): string | null
+    get_copyright(): string
     /**
      * Gets the data dir of the plugin.
      * 
@@ -821,7 +907,7 @@ interface PluginInfo {
      * file was found.
      * @returns the plugin's data dir.
      */
-    get_data_dir(): string | null
+    get_data_dir(): string
     /**
      * Gets the dependencies of the plugin.
      * 
@@ -843,7 +929,7 @@ interface PluginInfo {
      * The relevant key in the plugin info file is "Description".
      * @returns the plugin's description.
      */
-    get_description(): string | null
+    get_description(): string
     /**
      * Gets external data specified for the plugin.
      * 
@@ -856,7 +942,7 @@ interface PluginInfo {
      * @param key The key to lookup.
      * @returns the external data, or %NULL if the external data could not be found.
      */
-    get_external_data(key: string | null): string | null
+    get_external_data(key: string): string | null
     /**
      * Gets the help URI of the plugin.
      * 
@@ -869,7 +955,7 @@ interface PluginInfo {
      * "Help-Windows" and "Help-MacOS-X".
      * @returns the plugin's help URI.
      */
-    get_help_uri(): string | null
+    get_help_uri(): string
     /**
      * Gets the icon name of the plugin.
      * 
@@ -879,7 +965,7 @@ interface PluginInfo {
      * The relevant key in the plugin info file is "Icon".
      * @returns the plugin's icon name.
      */
-    get_icon_name(): string | null
+    get_icon_name(): string
     /**
      * Gets the module directory.
      * 
@@ -888,7 +974,7 @@ interface PluginInfo {
      * [class`Engine]`.
      * @returns the module directory.
      */
-    get_module_dir(): string | null
+    get_module_dir(): string
     /**
      * Gets the module name.
      * 
@@ -899,7 +985,7 @@ interface PluginInfo {
      * The relevant key in the plugin info file is "Module".
      * @returns the module name.
      */
-    get_module_name(): string | null
+    get_module_name(): string
     /**
      * Gets the name of the plugin.
      * 
@@ -908,7 +994,7 @@ interface PluginInfo {
      * The relevant key in the plugin info file is "Name".
      * @returns the plugin's name.
      */
-    get_name(): string | null
+    get_name(): string
     /**
      * Creates a new #GResource for the given `filename`
      * located in the module directory. If `filename` is %NULL
@@ -931,20 +1017,20 @@ interface PluginInfo {
      * The relevant key in the plugin info file is "Version".
      * @returns the plugin's version.
      */
-    get_version(): string | null
+    get_version(): string
     /**
      * Gets the website of the plugin.
      * 
      * The relevant key in the plugin info file is "Website".
      * @returns the plugin's associated website.
      */
-    get_website(): string | null
+    get_website(): string
     /**
      * Check if the plugin depends on another plugin.
      * @param module_name The name of the plugin to check.
      * @returns whether the plugin depends on the plugin @module_name.
      */
-    has_dependency(module_name: string | null): boolean
+    has_dependency(module_name: string): boolean
     /**
      * Check if the plugin is available.
      *