@girs/meta-18 4.2.0 → 4.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +8 -8
  2. package/meta-18.d.ts +37 -2
  3. package/package.json +19 -19
package/README.md CHANGED
@@ -5,25 +5,25 @@
5
5
  ![downloads/week](https://img.shields.io/npm/dw/@girs/meta-18)
6
6
 
7
7
 
8
- GJS TypeScript type definitions for Meta-18 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.2.0.
8
+ GJS TypeScript type definitions for Meta-18 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.4.0.
9
9
 
10
10
  ## Install
11
11
 
12
- To use this type definitions, install them with NPM:
12
+ Install the type definitions with npm:
13
13
  ```bash
14
14
  npm install @girs/meta-18
15
15
  ```
16
16
 
17
17
  ## Usage
18
18
 
19
- You can import this package into your project like this:
19
+ Import it like any other module:
20
20
  ```ts
21
21
  import Meta from '@girs/meta-18';
22
22
  ```
23
23
 
24
24
  ### Ambient Modules
25
25
 
26
- 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.
26
+ [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.
27
27
  For this you need to include `@girs/meta-18` or `@girs/meta-18/ambient` in your `tsconfig` or entry point Typescript file:
28
28
 
29
29
  `index.ts`:
@@ -42,7 +42,7 @@ import '@girs/meta-18'
42
42
  }
43
43
  ```
44
44
 
45
- Now you can import the ambient module with TypeScript support:
45
+ The ambient module now resolves with types:
46
46
 
47
47
  ```ts
48
48
  import Meta from 'gi://Meta?version=18';
@@ -50,7 +50,7 @@ import Meta from 'gi://Meta?version=18';
50
50
 
51
51
  ### Global import
52
52
 
53
- You can also import the module with Typescript support using the global `imports.gi` object of GJS.
53
+ GJS's global `imports.gi` works too, with types.
54
54
  For this you need to include `@girs/meta-18` or `@girs/meta-18/import` in your `tsconfig` or entry point Typescript file:
55
55
 
56
56
  `index.ts`:
@@ -69,7 +69,7 @@ import '@girs/meta-18'
69
69
  }
70
70
  ```
71
71
 
72
- Now you have also type support for this, too:
72
+ That form carries types as well:
73
73
 
74
74
  ```ts
75
75
  const Meta = imports.gi.Meta;
@@ -77,7 +77,7 @@ const Meta = imports.gi.Meta;
77
77
 
78
78
  ### Bundle
79
79
 
80
- 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).
80
+ 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.
81
81
 
82
82
  ## Other packages
83
83
 
package/meta-18.d.ts CHANGED
@@ -2510,6 +2510,7 @@ export namespace Meta {
2510
2510
  * instance.
2511
2511
  * @param cancellable optional {@link Gio.Cancellable} object, `null` to ignore.
2512
2512
  * @returns `true` if successful. If an error has occurred, this function will return `false` and set `error` appropriately if present.
2513
+ * @since 2.22
2513
2514
  */
2514
2515
  init(cancellable: Gio.Cancellable | null): boolean;
2515
2516
 
@@ -2553,6 +2554,7 @@ export namespace Meta {
2553
2554
  * on the result of `g_object_new()`, regardless of whether it is in fact a new
2554
2555
  * instance.
2555
2556
  * @param cancellable optional {@link Gio.Cancellable} object, `null` to ignore.
2557
+ * @since 2.22
2556
2558
  * @virtual
2557
2559
  */
2558
2560
  vfunc_init(cancellable: Gio.Cancellable | null): boolean;
@@ -3874,6 +3876,7 @@ export namespace Meta {
3874
3876
  * instance.
3875
3877
  * @param cancellable optional {@link Gio.Cancellable} object, `null` to ignore.
3876
3878
  * @returns `true` if successful. If an error has occurred, this function will return `false` and set `error` appropriately if present.
3879
+ * @since 2.22
3877
3880
  */
3878
3881
  init(cancellable: Gio.Cancellable | null): boolean;
3879
3882
 
@@ -3917,6 +3920,7 @@ export namespace Meta {
3917
3920
  * on the result of `g_object_new()`, regardless of whether it is in fact a new
3918
3921
  * instance.
3919
3922
  * @param cancellable optional {@link Gio.Cancellable} object, `null` to ignore.
3923
+ * @since 2.22
3920
3924
  * @virtual
3921
3925
  */
3922
3926
  vfunc_init(cancellable: Gio.Cancellable | null): boolean;
@@ -4418,26 +4422,41 @@ export namespace Meta {
4418
4422
  /**
4419
4423
  * Gets the {@link Gio.DBusObject} that `interface_` belongs to, if any.
4420
4424
  * @returns A {@link Gio.DBusObject} or `null`. The returned reference should be freed with `g_object_unref()`.
4425
+ * @since 2.32
4421
4426
  */
4422
4427
  get_object(): Gio.DBusObject | null;
4423
4428
 
4424
4429
  /**
4425
4430
  * Gets D-Bus introspection information for the D-Bus interface
4426
4431
  * implemented by `interface_`.
4432
+ *
4433
+ * This can return `null` if no {@link Gio.DBusInterfaceInfo} was provided during
4434
+ * construction of `interface_` and is also not made available otherwise.
4435
+ * For example, {@link Gio.DBusProxy} implements {@link Gio.DBusInterface} but allows for a `null`
4436
+ * {@link Gio.DBusInterfaceInfo}.
4427
4437
  * @returns A {@link Gio.DBusInterfaceInfo}. Do not free.
4438
+ * @since 2.30
4428
4439
  */
4429
- get_info(): Gio.DBusInterfaceInfo;
4440
+ get_info(): Gio.DBusInterfaceInfo | null;
4441
+
4442
+ /**
4443
+ * @param args
4444
+ */
4445
+ // Conflicted with Gio.DBusInterfaceSkeleton.get_info
4446
+ get_info(...args: never[]): any;
4430
4447
 
4431
4448
  /**
4432
4449
  * Sets the {@link Gio.DBusObject} for `interface_` to `object`.
4433
4450
  *
4434
4451
  * Note that `interface_` will hold a weak reference to `object`.
4435
4452
  * @param object A {@link Gio.DBusObject} or `null`.
4453
+ * @since 2.30
4436
4454
  */
4437
4455
  set_object(object: Gio.DBusObject | null): void;
4438
4456
 
4439
4457
  /**
4440
4458
  * Gets the {@link Gio.DBusObject} that `interface_` belongs to, if any.
4459
+ * @since 2.32
4441
4460
  * @virtual
4442
4461
  */
4443
4462
  vfunc_dup_object(): Gio.DBusObject | null;
@@ -4445,15 +4464,29 @@ export namespace Meta {
4445
4464
  /**
4446
4465
  * Gets D-Bus introspection information for the D-Bus interface
4447
4466
  * implemented by `interface_`.
4467
+ *
4468
+ * This can return `null` if no {@link Gio.DBusInterfaceInfo} was provided during
4469
+ * construction of `interface_` and is also not made available otherwise.
4470
+ * For example, {@link Gio.DBusProxy} implements {@link Gio.DBusInterface} but allows for a `null`
4471
+ * {@link Gio.DBusInterfaceInfo}.
4472
+ * @since 2.30
4473
+ * @virtual
4474
+ */
4475
+ vfunc_get_info(): Gio.DBusInterfaceInfo | null;
4476
+
4477
+ /**
4478
+ * @param args
4448
4479
  * @virtual
4449
4480
  */
4450
- vfunc_get_info(): Gio.DBusInterfaceInfo;
4481
+ // Conflicted with Gio.DBusInterfaceSkeleton.vfunc_get_info
4482
+ vfunc_get_info(...args: never[]): any;
4451
4483
 
4452
4484
  /**
4453
4485
  * Sets the {@link Gio.DBusObject} for `interface_` to `object`.
4454
4486
  *
4455
4487
  * Note that `interface_` will hold a weak reference to `object`.
4456
4488
  * @param object A {@link Gio.DBusObject} or `null`.
4489
+ * @since 2.30
4457
4490
  * @virtual
4458
4491
  */
4459
4492
  vfunc_set_object(object: Gio.DBusObject | null): void;
@@ -8488,6 +8521,7 @@ export namespace Meta {
8488
8521
  * instance.
8489
8522
  * @param cancellable optional {@link Gio.Cancellable} object, `null` to ignore.
8490
8523
  * @returns `true` if successful. If an error has occurred, this function will return `false` and set `error` appropriately if present.
8524
+ * @since 2.22
8491
8525
  */
8492
8526
  init(cancellable: Gio.Cancellable | null): boolean;
8493
8527
 
@@ -8531,6 +8565,7 @@ export namespace Meta {
8531
8565
  * on the result of `g_object_new()`, regardless of whether it is in fact a new
8532
8566
  * instance.
8533
8567
  * @param cancellable optional {@link Gio.Cancellable} object, `null` to ignore.
8568
+ * @since 2.22
8534
8569
  * @virtual
8535
8570
  */
8536
8571
  vfunc_init(cancellable: Gio.Cancellable | null): boolean;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@girs/meta-18",
3
- "version": "4.2.0",
3
+ "version": "4.4.0",
4
4
  "description": "GJS TypeScript type definitions for Meta-18",
5
5
  "type": "module",
6
6
  "module": "meta-18.js",
@@ -31,24 +31,24 @@
31
31
  "test": "tsc --project tsconfig.json"
32
32
  },
33
33
  "dependencies": {
34
- "@girs/gjs": "^4.2.0",
35
- "@girs/xlib-2.0": "^4.2.0",
36
- "@girs/xfixes-4.0": "^4.2.0",
37
- "@girs/mtk-18": "^4.2.0",
38
- "@girs/graphene-1.0": "^4.2.0",
39
- "@girs/gobject-2.0": "^4.2.0",
40
- "@girs/glib-2.0": "^4.2.0",
41
- "@girs/gio-2.0": "^4.2.0",
42
- "@girs/gmodule-2.0": "^4.2.0",
43
- "@girs/gdesktopenums-3.0": "^4.2.0",
44
- "@girs/cogl-18": "^4.2.0",
45
- "@girs/gl-1.0": "^4.2.0",
46
- "@girs/clutter-18": "^4.2.0",
47
- "@girs/pango-1.0": "^4.2.0",
48
- "@girs/cairo-1.0": "^4.2.0",
49
- "@girs/harfbuzz-0.0": "^4.2.0",
50
- "@girs/freetype2-2.0": "^4.2.0",
51
- "@girs/atk-1.0": "^4.2.0" },
34
+ "@girs/gjs": "^4.4.0",
35
+ "@girs/xlib-2.0": "^4.4.0",
36
+ "@girs/xfixes-4.0": "^4.4.0",
37
+ "@girs/mtk-18": "^4.4.0",
38
+ "@girs/graphene-1.0": "^4.4.0",
39
+ "@girs/gobject-2.0": "^4.4.0",
40
+ "@girs/glib-2.0": "^4.4.0",
41
+ "@girs/gio-2.0": "^4.4.0",
42
+ "@girs/gmodule-2.0": "^4.4.0",
43
+ "@girs/gdesktopenums-3.0": "^4.4.0",
44
+ "@girs/cogl-18": "^4.4.0",
45
+ "@girs/gl-1.0": "^4.4.0",
46
+ "@girs/clutter-18": "^4.4.0",
47
+ "@girs/pango-1.0": "^4.4.0",
48
+ "@girs/cairo-1.0": "^4.4.0",
49
+ "@girs/harfbuzz-0.0": "^4.4.0",
50
+ "@girs/freetype2-2.0": "^4.4.0",
51
+ "@girs/atk-1.0": "^4.4.0" },
52
52
  "devDependencies": {
53
53
  "typescript": "*"
54
54
  },