@girs/msg-0 0.0.0-4.0.0-beta.21 → 0.0.0-4.0.0-beta.23

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 +1 -1
  2. package/msg-0.d.ts +134 -15
  3. package/package.json +9 -9
package/README.md CHANGED
@@ -5,7 +5,7 @@
5
5
  ![downloads/week](https://img.shields.io/npm/dw/@girs/msg-0)
6
6
 
7
7
 
8
- GJS TypeScript type definitions for Msg-0, generated from library version 0.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0-beta.21.
8
+ GJS TypeScript type definitions for Msg-0, generated from library version 0.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0-beta.23.
9
9
 
10
10
 
11
11
  ## Install
package/msg-0.d.ts CHANGED
@@ -7,6 +7,8 @@
7
7
  * The based EJS template file is used for the generated .d.ts file of each GIR module like Gtk-4.0, GObject-2.0, ...
8
8
  */
9
9
 
10
+ import '@girs/gjs';
11
+
10
12
  // Module dependencies
11
13
  import type Soup from '@girs/soup-3.0';
12
14
  import type Gio from '@girs/gio-2.0';
@@ -701,7 +703,21 @@ export namespace Msg {
701
703
  * @returns the data if found, or %NULL if no such data exists.
702
704
  */
703
705
  get_data(key: string): any | null;
704
- get_property(property_name: string): any;
706
+ /**
707
+ * Gets a property of an object.
708
+ *
709
+ * The value can be:
710
+ * - an empty GObject.Value initialized by G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
711
+ * - a GObject.Value initialized with the expected type of the property
712
+ * - a GObject.Value initialized with a type to which the expected type of the property can be transformed
713
+ *
714
+ * In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
715
+ *
716
+ * Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
717
+ * @param property_name The name of the property to get
718
+ * @param value Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type
719
+ */
720
+ get_property(property_name: string, value: GObject.Value | any): any;
705
721
  /**
706
722
  * This function gets back user data pointers stored via
707
723
  * g_object_set_qdata().
@@ -829,7 +845,12 @@ export namespace Msg {
829
845
  * @param data data to associate with that key
830
846
  */
831
847
  set_data(key: string, data?: any | null): void;
832
- set_property(property_name: string, value: any): void;
848
+ /**
849
+ * Sets a property on an object.
850
+ * @param property_name The name of the property to set
851
+ * @param value The value to set the property to
852
+ */
853
+ set_property(property_name: string, value: GObject.Value | any): void;
833
854
  /**
834
855
  * Remove a specified datum from the object's data associations,
835
856
  * without invoking the association's destroy handler.
@@ -979,11 +1000,31 @@ export namespace Msg {
979
1000
  * @param pspec
980
1001
  */
981
1002
  vfunc_set_property(property_id: number, value: GObject.Value | any, pspec: GObject.ParamSpec): void;
1003
+ /**
1004
+ * Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.
1005
+ * @param id Handler ID of the handler to be disconnected
1006
+ */
982
1007
  disconnect(id: number): void;
1008
+ /**
1009
+ * Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
1010
+ * @param properties Object containing the properties to set
1011
+ */
983
1012
  set(properties: { [key: string]: any }): void;
984
- block_signal_handler(id: number): any;
985
- unblock_signal_handler(id: number): any;
986
- stop_emission_by_name(detailedName: string): any;
1013
+ /**
1014
+ * Blocks a handler of an instance so it will not be called during any signal emissions
1015
+ * @param id Handler ID of the handler to be blocked
1016
+ */
1017
+ block_signal_handler(id: number): void;
1018
+ /**
1019
+ * Unblocks a handler so it will be called again during any signal emissions
1020
+ * @param id Handler ID of the handler to be unblocked
1021
+ */
1022
+ unblock_signal_handler(id: number): void;
1023
+ /**
1024
+ * Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
1025
+ * @param detailedName Name of the signal to stop emission of
1026
+ */
1027
+ stop_emission_by_name(detailedName: string): void;
987
1028
  }
988
1029
 
989
1030
  namespace InputStream {
@@ -1235,7 +1276,21 @@ export namespace Msg {
1235
1276
  * @returns the data if found, or %NULL if no such data exists.
1236
1277
  */
1237
1278
  get_data(key: string): any | null;
1238
- get_property(property_name: string): any;
1279
+ /**
1280
+ * Gets a property of an object.
1281
+ *
1282
+ * The value can be:
1283
+ * - an empty GObject.Value initialized by G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
1284
+ * - a GObject.Value initialized with the expected type of the property
1285
+ * - a GObject.Value initialized with a type to which the expected type of the property can be transformed
1286
+ *
1287
+ * In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
1288
+ *
1289
+ * Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
1290
+ * @param property_name The name of the property to get
1291
+ * @param value Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type
1292
+ */
1293
+ get_property(property_name: string, value: GObject.Value | any): any;
1239
1294
  /**
1240
1295
  * This function gets back user data pointers stored via
1241
1296
  * g_object_set_qdata().
@@ -1363,7 +1418,12 @@ export namespace Msg {
1363
1418
  * @param data data to associate with that key
1364
1419
  */
1365
1420
  set_data(key: string, data?: any | null): void;
1366
- set_property(property_name: string, value: any): void;
1421
+ /**
1422
+ * Sets a property on an object.
1423
+ * @param property_name The name of the property to set
1424
+ * @param value The value to set the property to
1425
+ */
1426
+ set_property(property_name: string, value: GObject.Value | any): void;
1367
1427
  /**
1368
1428
  * Remove a specified datum from the object's data associations,
1369
1429
  * without invoking the association's destroy handler.
@@ -1513,11 +1573,31 @@ export namespace Msg {
1513
1573
  * @param pspec
1514
1574
  */
1515
1575
  vfunc_set_property(property_id: number, value: GObject.Value | any, pspec: GObject.ParamSpec): void;
1576
+ /**
1577
+ * Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.
1578
+ * @param id Handler ID of the handler to be disconnected
1579
+ */
1516
1580
  disconnect(id: number): void;
1581
+ /**
1582
+ * Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
1583
+ * @param properties Object containing the properties to set
1584
+ */
1517
1585
  set(properties: { [key: string]: any }): void;
1518
- block_signal_handler(id: number): any;
1519
- unblock_signal_handler(id: number): any;
1520
- stop_emission_by_name(detailedName: string): any;
1586
+ /**
1587
+ * Blocks a handler of an instance so it will not be called during any signal emissions
1588
+ * @param id Handler ID of the handler to be blocked
1589
+ */
1590
+ block_signal_handler(id: number): void;
1591
+ /**
1592
+ * Unblocks a handler so it will be called again during any signal emissions
1593
+ * @param id Handler ID of the handler to be unblocked
1594
+ */
1595
+ unblock_signal_handler(id: number): void;
1596
+ /**
1597
+ * Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
1598
+ * @param detailedName Name of the signal to stop emission of
1599
+ */
1600
+ stop_emission_by_name(detailedName: string): void;
1521
1601
  }
1522
1602
 
1523
1603
  namespace MailFolder {
@@ -1834,7 +1914,21 @@ export namespace Msg {
1834
1914
  * @returns the data if found, or %NULL if no such data exists.
1835
1915
  */
1836
1916
  get_data(key: string): any | null;
1837
- get_property(property_name: string): any;
1917
+ /**
1918
+ * Gets a property of an object.
1919
+ *
1920
+ * The value can be:
1921
+ * - an empty GObject.Value initialized by G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
1922
+ * - a GObject.Value initialized with the expected type of the property
1923
+ * - a GObject.Value initialized with a type to which the expected type of the property can be transformed
1924
+ *
1925
+ * In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
1926
+ *
1927
+ * Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
1928
+ * @param property_name The name of the property to get
1929
+ * @param value Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type
1930
+ */
1931
+ get_property(property_name: string, value: GObject.Value | any): any;
1838
1932
  /**
1839
1933
  * This function gets back user data pointers stored via
1840
1934
  * g_object_set_qdata().
@@ -1962,7 +2056,12 @@ export namespace Msg {
1962
2056
  * @param data data to associate with that key
1963
2057
  */
1964
2058
  set_data(key: string, data?: any | null): void;
1965
- set_property(property_name: string, value: any): void;
2059
+ /**
2060
+ * Sets a property on an object.
2061
+ * @param property_name The name of the property to set
2062
+ * @param value The value to set the property to
2063
+ */
2064
+ set_property(property_name: string, value: GObject.Value | any): void;
1966
2065
  /**
1967
2066
  * Remove a specified datum from the object's data associations,
1968
2067
  * without invoking the association's destroy handler.
@@ -2112,11 +2211,31 @@ export namespace Msg {
2112
2211
  * @param pspec
2113
2212
  */
2114
2213
  vfunc_set_property(property_id: number, value: GObject.Value | any, pspec: GObject.ParamSpec): void;
2214
+ /**
2215
+ * Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.
2216
+ * @param id Handler ID of the handler to be disconnected
2217
+ */
2115
2218
  disconnect(id: number): void;
2219
+ /**
2220
+ * Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
2221
+ * @param properties Object containing the properties to set
2222
+ */
2116
2223
  set(properties: { [key: string]: any }): void;
2117
- block_signal_handler(id: number): any;
2118
- unblock_signal_handler(id: number): any;
2119
- stop_emission_by_name(detailedName: string): any;
2224
+ /**
2225
+ * Blocks a handler of an instance so it will not be called during any signal emissions
2226
+ * @param id Handler ID of the handler to be blocked
2227
+ */
2228
+ block_signal_handler(id: number): void;
2229
+ /**
2230
+ * Unblocks a handler so it will be called again during any signal emissions
2231
+ * @param id Handler ID of the handler to be unblocked
2232
+ */
2233
+ unblock_signal_handler(id: number): void;
2234
+ /**
2235
+ * Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
2236
+ * @param detailedName Name of the signal to stop emission of
2237
+ */
2238
+ stop_emission_by_name(detailedName: string): void;
2120
2239
  }
2121
2240
 
2122
2241
  namespace Service {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@girs/msg-0",
3
- "version": "0.0.0-4.0.0-beta.21",
3
+ "version": "0.0.0-4.0.0-beta.23",
4
4
  "description": "GJS TypeScript type definitions for Msg-0, generated from library version 0.0.0",
5
5
  "type": "module",
6
6
  "module": "msg-0.js",
@@ -31,14 +31,14 @@
31
31
  "test": "tsc --project tsconfig.json"
32
32
  },
33
33
  "dependencies": {
34
- "@girs/gio-2.0": "^2.83.3-4.0.0-beta.21",
35
- "@girs/gjs": "^4.0.0-beta.21",
36
- "@girs/glib-2.0": "^2.83.3-4.0.0-beta.21",
37
- "@girs/gmodule-2.0": "^2.0.0-4.0.0-beta.21",
38
- "@girs/goa-1.0": "^3.52.0-4.0.0-beta.21",
39
- "@girs/gobject-2.0": "^2.83.3-4.0.0-beta.21",
40
- "@girs/json-1.0": "^1.10.7-4.0.0-beta.21",
41
- "@girs/soup-3.0": "^3.6.4-4.0.0-beta.21"
34
+ "@girs/gio-2.0": "^2.84.0-4.0.0-beta.23",
35
+ "@girs/gjs": "^4.0.0-beta.23",
36
+ "@girs/glib-2.0": "^2.84.0-4.0.0-beta.23",
37
+ "@girs/gmodule-2.0": "^2.0.0-4.0.0-beta.23",
38
+ "@girs/goa-1.0": "^3.52.0-4.0.0-beta.23",
39
+ "@girs/gobject-2.0": "^2.84.0-4.0.0-beta.23",
40
+ "@girs/json-1.0": "^1.10.7-4.0.0-beta.23",
41
+ "@girs/soup-3.0": "^3.6.4-4.0.0-beta.23"
42
42
  },
43
43
  "devDependencies": {
44
44
  "typescript": "*"