@girs/farstream-0.2 0.2.0-4.0.0-beta.21 → 0.2.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.
package/README.md CHANGED
@@ -5,7 +5,7 @@
5
5
  ![downloads/week](https://img.shields.io/npm/dw/@girs/farstream-0.2)
6
6
 
7
7
 
8
- GJS TypeScript type definitions for Farstream-0.2, generated from library version 0.2.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0-beta.21.
8
+ GJS TypeScript type definitions for Farstream-0.2, generated from library version 0.2.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0-beta.23.
9
9
 
10
10
 
11
11
  ## Install
@@ -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 Gst from '@girs/gst-1.0';
12
14
  import type GObject from '@girs/gobject-2.0';
@@ -630,8 +632,6 @@ export namespace Farstream {
630
632
  * @param value new #GValue for the property
631
633
  */
632
634
  set_property(name: string, value: GObject.Value | any): void;
633
- // Conflicted with GObject.Object.set_property
634
- set_property(...args: never[]): any;
635
635
  /**
636
636
  * Emits the #GstChildProxy::child-added signal.
637
637
  * @param child the newly added child
@@ -1057,11 +1057,31 @@ export namespace Farstream {
1057
1057
  * @param pspec
1058
1058
  */
1059
1059
  vfunc_set_property(property_id: number, value: GObject.Value | any, pspec: GObject.ParamSpec): void;
1060
+ /**
1061
+ * 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.
1062
+ * @param id Handler ID of the handler to be disconnected
1063
+ */
1060
1064
  disconnect(id: number): void;
1065
+ /**
1066
+ * Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
1067
+ * @param properties Object containing the properties to set
1068
+ */
1061
1069
  set(properties: { [key: string]: any }): void;
1062
- block_signal_handler(id: number): any;
1063
- unblock_signal_handler(id: number): any;
1064
- stop_emission_by_name(detailedName: string): any;
1070
+ /**
1071
+ * Blocks a handler of an instance so it will not be called during any signal emissions
1072
+ * @param id Handler ID of the handler to be blocked
1073
+ */
1074
+ block_signal_handler(id: number): void;
1075
+ /**
1076
+ * Unblocks a handler so it will be called again during any signal emissions
1077
+ * @param id Handler ID of the handler to be unblocked
1078
+ */
1079
+ unblock_signal_handler(id: number): void;
1080
+ /**
1081
+ * Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
1082
+ * @param detailedName Name of the signal to stop emission of
1083
+ */
1084
+ stop_emission_by_name(detailedName: string): void;
1065
1085
  }
1066
1086
 
1067
1087
  namespace ElementAddedNotifier {
@@ -1346,7 +1366,21 @@ export namespace Farstream {
1346
1366
  * @returns the data if found, or %NULL if no such data exists.
1347
1367
  */
1348
1368
  get_data(key: string): any | null;
1349
- get_property(property_name: string): any;
1369
+ /**
1370
+ * Gets a property of an object.
1371
+ *
1372
+ * The value can be:
1373
+ * - 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)
1374
+ * - a GObject.Value initialized with the expected type of the property
1375
+ * - a GObject.Value initialized with a type to which the expected type of the property can be transformed
1376
+ *
1377
+ * In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
1378
+ *
1379
+ * Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
1380
+ * @param property_name The name of the property to get
1381
+ * @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
1382
+ */
1383
+ get_property(property_name: string, value: GObject.Value | any): any;
1350
1384
  /**
1351
1385
  * This function gets back user data pointers stored via
1352
1386
  * g_object_set_qdata().
@@ -1474,7 +1508,12 @@ export namespace Farstream {
1474
1508
  * @param data data to associate with that key
1475
1509
  */
1476
1510
  set_data(key: string, data?: any | null): void;
1477
- set_property(property_name: string, value: any): void;
1511
+ /**
1512
+ * Sets a property on an object.
1513
+ * @param property_name The name of the property to set
1514
+ * @param value The value to set the property to
1515
+ */
1516
+ set_property(property_name: string, value: GObject.Value | any): void;
1478
1517
  /**
1479
1518
  * Remove a specified datum from the object's data associations,
1480
1519
  * without invoking the association's destroy handler.
@@ -1624,11 +1663,31 @@ export namespace Farstream {
1624
1663
  * @param pspec
1625
1664
  */
1626
1665
  vfunc_set_property(property_id: number, value: GObject.Value | any, pspec: GObject.ParamSpec): void;
1666
+ /**
1667
+ * 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.
1668
+ * @param id Handler ID of the handler to be disconnected
1669
+ */
1627
1670
  disconnect(id: number): void;
1671
+ /**
1672
+ * Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
1673
+ * @param properties Object containing the properties to set
1674
+ */
1628
1675
  set(properties: { [key: string]: any }): void;
1629
- block_signal_handler(id: number): any;
1630
- unblock_signal_handler(id: number): any;
1631
- stop_emission_by_name(detailedName: string): any;
1676
+ /**
1677
+ * Blocks a handler of an instance so it will not be called during any signal emissions
1678
+ * @param id Handler ID of the handler to be blocked
1679
+ */
1680
+ block_signal_handler(id: number): void;
1681
+ /**
1682
+ * Unblocks a handler so it will be called again during any signal emissions
1683
+ * @param id Handler ID of the handler to be unblocked
1684
+ */
1685
+ unblock_signal_handler(id: number): void;
1686
+ /**
1687
+ * Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
1688
+ * @param detailedName Name of the signal to stop emission of
1689
+ */
1690
+ stop_emission_by_name(detailedName: string): void;
1632
1691
  }
1633
1692
 
1634
1693
  namespace Session {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@girs/farstream-0.2",
3
- "version": "0.2.0-4.0.0-beta.21",
3
+ "version": "0.2.0-4.0.0-beta.23",
4
4
  "description": "GJS TypeScript type definitions for Farstream-0.2, generated from library version 0.2.0",
5
5
  "type": "module",
6
6
  "module": "farstream-0.2.js",
@@ -31,11 +31,11 @@
31
31
  "test": "tsc --project tsconfig.json"
32
32
  },
33
33
  "dependencies": {
34
- "@girs/gjs": "^4.0.0-beta.21",
35
- "@girs/glib-2.0": "^2.83.3-4.0.0-beta.21",
36
- "@girs/gmodule-2.0": "^2.0.0-4.0.0-beta.21",
37
- "@girs/gobject-2.0": "^2.83.3-4.0.0-beta.21",
38
- "@girs/gst-1.0": "^1.24.12-4.0.0-beta.21"
34
+ "@girs/gjs": "^4.0.0-beta.23",
35
+ "@girs/glib-2.0": "^2.84.0-4.0.0-beta.23",
36
+ "@girs/gmodule-2.0": "^2.0.0-4.0.0-beta.23",
37
+ "@girs/gobject-2.0": "^2.84.0-4.0.0-beta.23",
38
+ "@girs/gst-1.0": "^1.24.12-4.0.0-beta.23"
39
39
  },
40
40
  "devDependencies": {
41
41
  "typescript": "*"