@girs/meta-13 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-13.d.ts +26 -0
  3. package/package.json +22 -22
package/README.md CHANGED
@@ -5,25 +5,25 @@
5
5
  ![downloads/week](https://img.shields.io/npm/dw/@girs/meta-13)
6
6
 
7
7
 
8
- GJS TypeScript type definitions for Meta-13 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.2.0.
8
+ GJS TypeScript type definitions for Meta-13 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-13
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-13';
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-13` or `@girs/meta-13/ambient` in your `tsconfig` or entry point Typescript file:
28
28
 
29
29
  `index.ts`:
@@ -42,7 +42,7 @@ import '@girs/meta-13'
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=13';
@@ -50,7 +50,7 @@ import Meta from 'gi://Meta?version=13';
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-13` or `@girs/meta-13/import` in your `tsconfig` or entry point Typescript file:
55
55
 
56
56
  `index.ts`:
@@ -69,7 +69,7 @@ import '@girs/meta-13'
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-13.d.ts CHANGED
@@ -2564,6 +2564,7 @@ export namespace Meta {
2564
2564
  * instance.
2565
2565
  * @param cancellable optional {@link Gio.Cancellable} object, `null` to ignore.
2566
2566
  * @returns `true` if successful. If an error has occurred, this function will return `false` and set `error` appropriately if present.
2567
+ * @since 2.22
2567
2568
  */
2568
2569
  init(cancellable: Gio.Cancellable | null): boolean;
2569
2570
 
@@ -2607,6 +2608,7 @@ export namespace Meta {
2607
2608
  * on the result of `g_object_new()`, regardless of whether it is in fact a new
2608
2609
  * instance.
2609
2610
  * @param cancellable optional {@link Gio.Cancellable} object, `null` to ignore.
2611
+ * @since 2.22
2610
2612
  * @virtual
2611
2613
  */
2612
2614
  vfunc_init(cancellable: Gio.Cancellable | null): boolean;
@@ -2959,6 +2961,7 @@ export namespace Meta {
2959
2961
  * deprecated virtual function. The default implementation will
2960
2962
  * call `clutter_actor_add_child()`.
2961
2963
  * @param actor the first {@link Clutter.Actor} to add
2964
+ * @deprecated since 1.10: Use `clutter_actor_add_child()` instead.
2962
2965
  */
2963
2966
  add_actor(actor: A): void;
2964
2967
 
@@ -3046,6 +3049,7 @@ export namespace Meta {
3046
3049
  * deprecated virtual function. The default implementation will call
3047
3050
  * `clutter_actor_remove_child()`.
3048
3051
  * @param actor a {@link Clutter.Actor}
3052
+ * @deprecated since 1.10: Use `clutter_actor_remove_child()` instead.
3049
3053
  */
3050
3054
  remove_actor(actor: A): void;
3051
3055
 
@@ -3071,6 +3075,7 @@ export namespace Meta {
3071
3075
  * deprecated virtual function. The default implementation will
3072
3076
  * call `clutter_actor_add_child()`.
3073
3077
  * @param actor the first {@link Clutter.Actor} to add
3078
+ * @deprecated since 1.10: Use `clutter_actor_add_child()` instead.
3074
3079
  * @virtual
3075
3080
  */
3076
3081
  vfunc_add(actor: A): void;
@@ -3132,6 +3137,7 @@ export namespace Meta {
3132
3137
  * deprecated virtual function. The default implementation will call
3133
3138
  * `clutter_actor_remove_child()`.
3134
3139
  * @param actor a {@link Clutter.Actor}
3140
+ * @deprecated since 1.10: Use `clutter_actor_remove_child()` instead.
3135
3141
  * @virtual
3136
3142
  */
3137
3143
  vfunc_remove(actor: A): void;
@@ -3762,6 +3768,7 @@ export namespace Meta {
3762
3768
  * deprecated virtual function. The default implementation will
3763
3769
  * call `clutter_actor_add_child()`.
3764
3770
  * @param actor the first {@link Clutter.Actor} to add
3771
+ * @deprecated since 1.10: Use `clutter_actor_add_child()` instead.
3765
3772
  */
3766
3773
  add_actor(actor: A): void;
3767
3774
 
@@ -3849,6 +3856,7 @@ export namespace Meta {
3849
3856
  * deprecated virtual function. The default implementation will call
3850
3857
  * `clutter_actor_remove_child()`.
3851
3858
  * @param actor a {@link Clutter.Actor}
3859
+ * @deprecated since 1.10: Use `clutter_actor_remove_child()` instead.
3852
3860
  */
3853
3861
  remove_actor(actor: A): void;
3854
3862
 
@@ -3874,6 +3882,7 @@ export namespace Meta {
3874
3882
  * deprecated virtual function. The default implementation will
3875
3883
  * call `clutter_actor_add_child()`.
3876
3884
  * @param actor the first {@link Clutter.Actor} to add
3885
+ * @deprecated since 1.10: Use `clutter_actor_add_child()` instead.
3877
3886
  * @virtual
3878
3887
  */
3879
3888
  vfunc_add(actor: A): void;
@@ -3935,6 +3944,7 @@ export namespace Meta {
3935
3944
  * deprecated virtual function. The default implementation will call
3936
3945
  * `clutter_actor_remove_child()`.
3937
3946
  * @param actor a {@link Clutter.Actor}
3947
+ * @deprecated since 1.10: Use `clutter_actor_remove_child()` instead.
3938
3948
  * @virtual
3939
3949
  */
3940
3950
  vfunc_remove(actor: A): void;
@@ -4336,6 +4346,7 @@ export namespace Meta {
4336
4346
  * instance.
4337
4347
  * @param cancellable optional {@link Gio.Cancellable} object, `null` to ignore.
4338
4348
  * @returns `true` if successful. If an error has occurred, this function will return `false` and set `error` appropriately if present.
4349
+ * @since 2.22
4339
4350
  */
4340
4351
  init(cancellable: Gio.Cancellable | null): boolean;
4341
4352
 
@@ -4379,6 +4390,7 @@ export namespace Meta {
4379
4390
  * on the result of `g_object_new()`, regardless of whether it is in fact a new
4380
4391
  * instance.
4381
4392
  * @param cancellable optional {@link Gio.Cancellable} object, `null` to ignore.
4393
+ * @since 2.22
4382
4394
  * @virtual
4383
4395
  */
4384
4396
  vfunc_init(cancellable: Gio.Cancellable | null): boolean;
@@ -6984,6 +6996,7 @@ export namespace Meta {
6984
6996
  * deprecated virtual function. The default implementation will
6985
6997
  * call `clutter_actor_add_child()`.
6986
6998
  * @param actor the first {@link Clutter.Actor} to add
6999
+ * @deprecated since 1.10: Use `clutter_actor_add_child()` instead.
6987
7000
  */
6988
7001
  add_actor(actor: A): void;
6989
7002
 
@@ -7071,6 +7084,7 @@ export namespace Meta {
7071
7084
  * deprecated virtual function. The default implementation will call
7072
7085
  * `clutter_actor_remove_child()`.
7073
7086
  * @param actor a {@link Clutter.Actor}
7087
+ * @deprecated since 1.10: Use `clutter_actor_remove_child()` instead.
7074
7088
  */
7075
7089
  remove_actor(actor: A): void;
7076
7090
 
@@ -7096,6 +7110,7 @@ export namespace Meta {
7096
7110
  * deprecated virtual function. The default implementation will
7097
7111
  * call `clutter_actor_add_child()`.
7098
7112
  * @param actor the first {@link Clutter.Actor} to add
7113
+ * @deprecated since 1.10: Use `clutter_actor_add_child()` instead.
7099
7114
  * @virtual
7100
7115
  */
7101
7116
  vfunc_add(actor: A): void;
@@ -7157,6 +7172,7 @@ export namespace Meta {
7157
7172
  * deprecated virtual function. The default implementation will call
7158
7173
  * `clutter_actor_remove_child()`.
7159
7174
  * @param actor a {@link Clutter.Actor}
7175
+ * @deprecated since 1.10: Use `clutter_actor_remove_child()` instead.
7160
7176
  * @virtual
7161
7177
  */
7162
7178
  vfunc_remove(actor: A): void;
@@ -8608,6 +8624,7 @@ export namespace Meta {
8608
8624
  * instance.
8609
8625
  * @param cancellable optional {@link Gio.Cancellable} object, `null` to ignore.
8610
8626
  * @returns `true` if successful. If an error has occurred, this function will return `false` and set `error` appropriately if present.
8627
+ * @since 2.22
8611
8628
  */
8612
8629
  init(cancellable: Gio.Cancellable | null): boolean;
8613
8630
 
@@ -8651,6 +8668,7 @@ export namespace Meta {
8651
8668
  * on the result of `g_object_new()`, regardless of whether it is in fact a new
8652
8669
  * instance.
8653
8670
  * @param cancellable optional {@link Gio.Cancellable} object, `null` to ignore.
8671
+ * @since 2.22
8654
8672
  * @virtual
8655
8673
  */
8656
8674
  vfunc_init(cancellable: Gio.Cancellable | null): boolean;
@@ -8983,6 +9001,7 @@ export namespace Meta {
8983
9001
  * deprecated virtual function. The default implementation will
8984
9002
  * call `clutter_actor_add_child()`.
8985
9003
  * @param actor the first {@link Clutter.Actor} to add
9004
+ * @deprecated since 1.10: Use `clutter_actor_add_child()` instead.
8986
9005
  */
8987
9006
  add_actor(actor: A): void;
8988
9007
 
@@ -9070,6 +9089,7 @@ export namespace Meta {
9070
9089
  * deprecated virtual function. The default implementation will call
9071
9090
  * `clutter_actor_remove_child()`.
9072
9091
  * @param actor a {@link Clutter.Actor}
9092
+ * @deprecated since 1.10: Use `clutter_actor_remove_child()` instead.
9073
9093
  */
9074
9094
  remove_actor(actor: A): void;
9075
9095
 
@@ -9095,6 +9115,7 @@ export namespace Meta {
9095
9115
  * deprecated virtual function. The default implementation will
9096
9116
  * call `clutter_actor_add_child()`.
9097
9117
  * @param actor the first {@link Clutter.Actor} to add
9118
+ * @deprecated since 1.10: Use `clutter_actor_add_child()` instead.
9098
9119
  * @virtual
9099
9120
  */
9100
9121
  vfunc_add(actor: A): void;
@@ -9156,6 +9177,7 @@ export namespace Meta {
9156
9177
  * deprecated virtual function. The default implementation will call
9157
9178
  * `clutter_actor_remove_child()`.
9158
9179
  * @param actor a {@link Clutter.Actor}
9180
+ * @deprecated since 1.10: Use `clutter_actor_remove_child()` instead.
9159
9181
  * @virtual
9160
9182
  */
9161
9183
  vfunc_remove(actor: A): void;
@@ -9451,6 +9473,7 @@ export namespace Meta {
9451
9473
  * deprecated virtual function. The default implementation will
9452
9474
  * call `clutter_actor_add_child()`.
9453
9475
  * @param actor the first {@link Clutter.Actor} to add
9476
+ * @deprecated since 1.10: Use `clutter_actor_add_child()` instead.
9454
9477
  */
9455
9478
  add_actor(actor: A): void;
9456
9479
 
@@ -9538,6 +9561,7 @@ export namespace Meta {
9538
9561
  * deprecated virtual function. The default implementation will call
9539
9562
  * `clutter_actor_remove_child()`.
9540
9563
  * @param actor a {@link Clutter.Actor}
9564
+ * @deprecated since 1.10: Use `clutter_actor_remove_child()` instead.
9541
9565
  */
9542
9566
  remove_actor(actor: A): void;
9543
9567
 
@@ -9563,6 +9587,7 @@ export namespace Meta {
9563
9587
  * deprecated virtual function. The default implementation will
9564
9588
  * call `clutter_actor_add_child()`.
9565
9589
  * @param actor the first {@link Clutter.Actor} to add
9590
+ * @deprecated since 1.10: Use `clutter_actor_add_child()` instead.
9566
9591
  * @virtual
9567
9592
  */
9568
9593
  vfunc_add(actor: A): void;
@@ -9624,6 +9649,7 @@ export namespace Meta {
9624
9649
  * deprecated virtual function. The default implementation will call
9625
9650
  * `clutter_actor_remove_child()`.
9626
9651
  * @param actor a {@link Clutter.Actor}
9652
+ * @deprecated since 1.10: Use `clutter_actor_remove_child()` instead.
9627
9653
  * @virtual
9628
9654
  */
9629
9655
  vfunc_remove(actor: A): void;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@girs/meta-13",
3
- "version": "4.2.0",
3
+ "version": "4.4.0",
4
4
  "description": "GJS TypeScript type definitions for Meta-13",
5
5
  "type": "module",
6
6
  "module": "meta-13.js",
@@ -31,27 +31,27 @@
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-13": "^4.2.0",
38
- "@girs/cairo-1.0": "^4.2.0",
39
- "@girs/gobject-2.0": "^4.2.0",
40
- "@girs/glib-2.0": "^4.2.0",
41
- "@girs/graphene-1.0": "^4.2.0",
42
- "@girs/gdesktopenums-3.0": "^4.2.0",
43
- "@girs/coglpango-13": "^4.2.0",
44
- "@girs/pangocairo-1.0": "^4.2.0",
45
- "@girs/pango-1.0": "^4.2.0",
46
- "@girs/harfbuzz-0.0": "^4.2.0",
47
- "@girs/freetype2-2.0": "^4.2.0",
48
- "@girs/gio-2.0": "^4.2.0",
49
- "@girs/gmodule-2.0": "^4.2.0",
50
- "@girs/cogl-13": "^4.2.0",
51
- "@girs/gl-1.0": "^4.2.0",
52
- "@girs/clutter-13": "^4.2.0",
53
- "@girs/json-1.0": "^4.2.0",
54
- "@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-13": "^4.4.0",
38
+ "@girs/cairo-1.0": "^4.4.0",
39
+ "@girs/gobject-2.0": "^4.4.0",
40
+ "@girs/glib-2.0": "^4.4.0",
41
+ "@girs/graphene-1.0": "^4.4.0",
42
+ "@girs/gdesktopenums-3.0": "^4.4.0",
43
+ "@girs/coglpango-13": "^4.4.0",
44
+ "@girs/pangocairo-1.0": "^4.4.0",
45
+ "@girs/pango-1.0": "^4.4.0",
46
+ "@girs/harfbuzz-0.0": "^4.4.0",
47
+ "@girs/freetype2-2.0": "^4.4.0",
48
+ "@girs/gio-2.0": "^4.4.0",
49
+ "@girs/gmodule-2.0": "^4.4.0",
50
+ "@girs/cogl-13": "^4.4.0",
51
+ "@girs/gl-1.0": "^4.4.0",
52
+ "@girs/clutter-13": "^4.4.0",
53
+ "@girs/json-1.0": "^4.4.0",
54
+ "@girs/atk-1.0": "^4.4.0" },
55
55
  "devDependencies": {
56
56
  "typescript": "*"
57
57
  },