@girs/gudev-1.0 4.2.0 → 4.4.0

package/README.md

@@ -5,25 +5,25 @@
 ![downloads/week](https://img.shields.io/npm/dw/@girs/gudev-1.0)
 
 
-GJS TypeScript type definitions for GUdev-1.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.2.0.
+GJS TypeScript type definitions for GUdev-1.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.4.0.
 
 ## Install
 
-To use this type definitions, install them with NPM:
+Install the type definitions with npm:
 ```bash
 npm install @girs/gudev-1.0
 ```
 
 ## Usage
 
-You can import this package into your project like this:
+Import it like any other module:
 ```ts
 import GUdev from '@girs/gudev-1.0';
 ```
 
 ### Ambient Modules
 
-You can also use [ambient modules](https://github.com/gjsify/ts-for-gir/tree/main/packages/cli#ambient-modules) to import this module like you would do this in JavaScript.
+[Ambient modules](https://github.com/gjsify/ts-for-gir/tree/main/packages/cli#ambient-modules) let you write the same import you would in plain JavaScript.
 For this you need to include `@girs/gudev-1.0` or `@girs/gudev-1.0/ambient` in your `tsconfig` or entry point Typescript file:
 
 `index.ts`:
@@ -42,7 +42,7 @@ import '@girs/gudev-1.0'
 }
 ```
 
-Now you can import the ambient module with TypeScript support: 
+The ambient module now resolves with types:
 
 ```ts
 import GUdev from 'gi://GUdev?version=1.0';
@@ -50,7 +50,7 @@ import GUdev from 'gi://GUdev?version=1.0';
 
 ### Global import
 
-You can also import the module with Typescript support using the global `imports.gi` object of GJS.
+GJS's global `imports.gi` works too, with types.
 For this you need to include `@girs/gudev-1.0` or `@girs/gudev-1.0/import` in your `tsconfig` or entry point Typescript file:
 
 `index.ts`:
@@ -69,7 +69,7 @@ import '@girs/gudev-1.0'
 }
 ```
 
-Now you have also type support for this, too:
+That form carries types as well:
 
 ```ts
 const GUdev = imports.gi.GUdev;
@@ -77,7 +77,7 @@ const GUdev = imports.gi.GUdev;
 
 ### Bundle
 
-Depending on your project configuration, it is recommended to use a bundler like [esbuild](https://esbuild.github.io/). You can find examples using different bundlers [here](https://github.com/gjsify/ts-for-gir/tree/main/examples).
+Most projects want a bundler. [esbuild](https://esbuild.github.io/) is the smallest thing that works; the [examples directory](https://github.com/gjsify/ts-for-gir/tree/main/examples) has setups for several others.
 
 ## Other packages
 

package/gudev-1.0.d.ts

@@ -151,6 +151,7 @@ export namespace GUdev {
 
         // Virtual methods
         /**
+         * Signal class handler for the {@link GUdev.Client.SignalSignatures.uevent | GUdev.Client::uevent} signal.
          * @param action 
          * @param device 
          * @virtual
@@ -296,6 +297,7 @@ export namespace GUdev {
          * 
          * https://www.freedesktop.org/software/systemd/man/udev_device_has_current_tag.html
          * @returns A `null` terminated string array of current tags. This array is owned by `device` and should not be freed by the caller.
+         * @since 238
          */
         get_current_tags(): string[];
 
@@ -339,6 +341,7 @@ export namespace GUdev {
         /**
          * Gets whether `device` has been initialized.
          * @returns Whether `device` has been initialized.
+         * @since 165
          */
         get_is_initialized(): boolean;
 
@@ -475,6 +478,7 @@ export namespace GUdev {
          * Before version 238 the uncached getters would not strip trailing newlines.
          * @param name Name of the sysfs attribute.
          * @returns The value of the sysfs attribute or `false` if there is no such attribute.
+         * @since 234
          */
         get_sysfs_attr_as_boolean_uncached(name: string): boolean;
 
@@ -496,6 +500,7 @@ export namespace GUdev {
          * Before version 238 the uncached getters would not strip trailing newlines.
          * @param name Name of the sysfs attribute.
          * @returns The value of the sysfs attribute or 0.0 if there is no such attribute.
+         * @since 234
          */
         get_sysfs_attr_as_double_uncached(name: string): number;
 
@@ -517,6 +522,7 @@ export namespace GUdev {
          * Before version 238 the uncached getters would not strip trailing newlines.
          * @param name Name of the sysfs attribute.
          * @returns The value of the sysfs attribute or 0 if there is no such attribute.
+         * @since 234
          */
         get_sysfs_attr_as_int_uncached(name: string): number;
 
@@ -545,6 +551,7 @@ export namespace GUdev {
          * This function does blocking I/O, and updates the sysfs attributes cache.
          * @param name Name of the sysfs attribute.
          * @returns The value of the sysfs attribute split into tokens or `null` if there is no such attribute. This array is owned by `device` and should not be freed by the caller. Before version 238 the uncached getters would not strip trailing newlines.
+         * @since 234
          */
         get_sysfs_attr_as_strv_uncached(name: string): string[] | null;
 
@@ -566,6 +573,7 @@ export namespace GUdev {
          * Before version 238 the uncached getters would not strip trailing newlines.
          * @param name Name of the sysfs attribute.
          * @returns The value of the sysfs attribute or 0 if there is no such attribute.
+         * @since 234
          */
         get_sysfs_attr_as_uint64_uncached(name: string): number;
 
@@ -582,6 +590,7 @@ export namespace GUdev {
          * Before version 238 the uncached getters would not strip trailing newlines.
          * @param name Name of the sysfs attribute.
          * @returns The value of the sysfs attribute or `null` if there is no such attribute. Do not free this string, it is owned by `device`.
+         * @since 234
          */
         get_sysfs_attr_uncached(name: string): string | null;
 
@@ -594,6 +603,7 @@ export namespace GUdev {
         /**
          * Gets all tags for `device`.
          * @returns A `null` terminated string array of tags. This array is owned by `device` and should not be freed by the caller.
+         * @since 165
          */
         get_tags(): string[];
 
@@ -603,6 +613,7 @@ export namespace GUdev {
          * This only works for devices with properties in the udev
          * database. All other devices return 0.
          * @returns Number of micro-seconds since `device` was initialized or 0 if unknown.
+         * @since 165
          */
         get_usec_since_initialized(): number;
 
@@ -632,6 +643,7 @@ export namespace GUdev {
          * functions.
          * @param key Name of sysfs attribute.
          * @returns `true` only if the value for `key` exist.
+         * @since 234
          */
         has_sysfs_attr_uncached(key: string): boolean;
     }
@@ -698,6 +710,7 @@ export namespace GUdev {
         /**
          * All returned devices will be initialized.
          * @returns The passed in `enumerator`.
+         * @since 165
          */
         add_match_is_initialized(): Enumerator;
 
@@ -705,6 +718,7 @@ export namespace GUdev {
          * All returned devices will match the given `name`.
          * @param name Wildcard filter for kernel name e.g. "sda*".
          * @returns The passed in `enumerator`.
+         * @since 165
          */
         add_match_name(name: string): Enumerator;
 
@@ -713,6 +727,7 @@ export namespace GUdev {
          * @param name Wildcard filter for property name.
          * @param value Wildcard filter for property value.
          * @returns The passed in `enumerator`.
+         * @since 165
          */
         add_match_property(name: string, value: string): Enumerator;
 
@@ -720,6 +735,7 @@ export namespace GUdev {
          * All returned devices will match the given `subsystem`.
          * @param subsystem Wildcard for subsystem name e.g. 'scsi' or 'a*'.
          * @returns The passed in `enumerator`.
+         * @since 165
          */
         add_match_subsystem(subsystem: string): Enumerator;
 
@@ -728,6 +744,7 @@ export namespace GUdev {
          * @param name Wildcard filter for sysfs attribute key.
          * @param value Wildcard filter for sysfs attribute value.
          * @returns The passed in `enumerator`.
+         * @since 165
          */
         add_match_sysfs_attr(name: string, value: string): Enumerator;
 
@@ -735,6 +752,7 @@ export namespace GUdev {
          * All returned devices will match the given `tag`.
          * @param tag A udev tag e.g. "udev-acl".
          * @returns The passed in `enumerator`.
+         * @since 165
          */
         add_match_tag(tag: string): Enumerator;
 
@@ -742,6 +760,7 @@ export namespace GUdev {
          * All returned devices will not match the given `subsystem`.
          * @param subsystem Wildcard for subsystem name e.g. 'scsi' or 'a*'.
          * @returns The passed in `enumerator`.
+         * @since 165
          */
         add_nomatch_subsystem(subsystem: string): Enumerator;
 
@@ -750,6 +769,7 @@ export namespace GUdev {
          * @param name Wildcard filter for sysfs attribute key.
          * @param value Wildcard filter for sysfs attribute value.
          * @returns The passed in `enumerator`.
+         * @since 165
          */
         add_nomatch_sysfs_attr(name: string, value: string): Enumerator;
 
@@ -757,12 +777,14 @@ export namespace GUdev {
          * Add a device to the list of devices, to retrieve it back sorted in dependency order.
          * @param sysfs_path A sysfs path, e.g. "/sys/devices/pci0000:00/0000:00:1f.2/host0/target0:0:0/0:0:0:0/block/sda"
          * @returns The passed in `enumerator`.
+         * @since 165
          */
         add_sysfs_path(sysfs_path: string): Enumerator;
 
         /**
          * Executes the query in `enumerator`.
          * @returns A list of {@link GUdev.Device} objects. The caller should free the result by using `g_object_unref()` on each element in the list and then `g_list_free()` on the list.
+         * @since 165
          */
         execute(): Device[];
     }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@girs/gudev-1.0",
-    "version": "4.2.0",
+    "version": "4.4.0",
     "description": "GJS TypeScript type definitions for GUdev-1.0",
     "type": "module",
     "module": "gudev-1.0.js",
@@ -31,9 +31,9 @@
       "test": "tsc --project tsconfig.json"
     },
     "dependencies": {
-      "@girs/gjs": "^4.2.0",
-      "@girs/gobject-2.0": "^4.2.0",
-      "@girs/glib-2.0": "^4.2.0"    },
+      "@girs/gjs": "^4.4.0",
+      "@girs/gobject-2.0": "^4.4.0",
+      "@girs/glib-2.0": "^4.4.0"    },
     "devDependencies": {
       "typescript": "*"
     },