@girs/gobject-2.0 2.82.2-4.0.0-beta.18 → 2.82.4-4.0.0-beta.20

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/gobject-2.0)
6
6
 
7
7
 
8
- GJS TypeScript type definitions for GObject-2.0, generated from library version 2.82.2 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0-beta.18.
8
+ GJS TypeScript type definitions for GObject-2.0, generated from library version 2.82.4 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0-beta.20.
9
9
 
10
10
 
11
11
  ## Install
package/gobject-2.0.d.ts CHANGED
@@ -40,6 +40,7 @@ export namespace GObject {
40
40
  Template?: Uint8Array | GLib.Bytes | string;
41
41
  Children?: string[];
42
42
  InternalChildren?: string[];
43
+ Requires?: Object[];
43
44
  }
44
45
 
45
46
  // Correctly types interface checks.
@@ -941,7 +942,7 @@ export namespace GObject {
941
942
  nick: string | null,
942
943
  blurb: string | null,
943
944
  default_value: boolean,
944
- flags: ParamFlags,
945
+ flags: ParamFlags | null,
945
946
  ): ParamSpec;
946
947
  /**
947
948
  * Creates a new #GParamSpecBoxed instance specifying a %G_TYPE_BOXED
@@ -960,7 +961,7 @@ export namespace GObject {
960
961
  nick: string | null,
961
962
  blurb: string | null,
962
963
  boxed_type: GType,
963
- flags: ParamFlags,
964
+ flags: ParamFlags | null,
964
965
  ): ParamSpec;
965
966
  /**
966
967
  * Creates a new #GParamSpecChar instance specifying a %G_TYPE_CHAR property.
@@ -980,7 +981,7 @@ export namespace GObject {
980
981
  minimum: number,
981
982
  maximum: number,
982
983
  default_value: number,
983
- flags: ParamFlags,
984
+ flags: ParamFlags | null,
984
985
  ): ParamSpec;
985
986
  /**
986
987
  * Creates a new #GParamSpecDouble instance specifying a %G_TYPE_DOUBLE
@@ -1003,7 +1004,7 @@ export namespace GObject {
1003
1004
  minimum: number,
1004
1005
  maximum: number,
1005
1006
  default_value: number,
1006
- flags: ParamFlags,
1007
+ flags: ParamFlags | null,
1007
1008
  ): ParamSpec;
1008
1009
  /**
1009
1010
  * Creates a new #GParamSpecEnum instance specifying a %G_TYPE_ENUM
@@ -1024,7 +1025,7 @@ export namespace GObject {
1024
1025
  blurb: string | null,
1025
1026
  enum_type: GType,
1026
1027
  default_value: number,
1027
- flags: ParamFlags,
1028
+ flags: ParamFlags | null,
1028
1029
  ): ParamSpec;
1029
1030
  /**
1030
1031
  * Creates a new #GParamSpecFlags instance specifying a %G_TYPE_FLAGS
@@ -1045,7 +1046,7 @@ export namespace GObject {
1045
1046
  blurb: string | null,
1046
1047
  flags_type: GType,
1047
1048
  default_value: number,
1048
- flags: ParamFlags,
1049
+ flags: ParamFlags | null,
1049
1050
  ): ParamSpec;
1050
1051
  /**
1051
1052
  * Creates a new #GParamSpecFloat instance specifying a %G_TYPE_FLOAT property.
@@ -1067,7 +1068,7 @@ export namespace GObject {
1067
1068
  minimum: number,
1068
1069
  maximum: number,
1069
1070
  default_value: number,
1070
- flags: ParamFlags,
1071
+ flags: ParamFlags | null,
1071
1072
  ): ParamSpec;
1072
1073
  /**
1073
1074
  * Creates a new #GParamSpecGType instance specifying a
@@ -1086,7 +1087,7 @@ export namespace GObject {
1086
1087
  nick: string | null,
1087
1088
  blurb: string | null,
1088
1089
  is_a_type: GType,
1089
- flags: ParamFlags,
1090
+ flags: ParamFlags | null,
1090
1091
  ): ParamSpec;
1091
1092
  /**
1092
1093
  * Creates a new #GParamSpecInt instance specifying a %G_TYPE_INT property.
@@ -1108,7 +1109,7 @@ export namespace GObject {
1108
1109
  minimum: number,
1109
1110
  maximum: number,
1110
1111
  default_value: number,
1111
- flags: ParamFlags,
1112
+ flags: ParamFlags | null,
1112
1113
  ): ParamSpec;
1113
1114
  /**
1114
1115
  * Creates a new #GParamSpecInt64 instance specifying a %G_TYPE_INT64 property.
@@ -1130,7 +1131,7 @@ export namespace GObject {
1130
1131
  minimum: number,
1131
1132
  maximum: number,
1132
1133
  default_value: number,
1133
- flags: ParamFlags,
1134
+ flags: ParamFlags | null,
1134
1135
  ): ParamSpec;
1135
1136
  /**
1136
1137
  * Creates a new #GParamSpecLong instance specifying a %G_TYPE_LONG property.
@@ -1152,7 +1153,7 @@ export namespace GObject {
1152
1153
  minimum: number,
1153
1154
  maximum: number,
1154
1155
  default_value: number,
1155
- flags: ParamFlags,
1156
+ flags: ParamFlags | null,
1156
1157
  ): ParamSpec;
1157
1158
  /**
1158
1159
  * Creates a new #GParamSpecBoxed instance specifying a %G_TYPE_OBJECT
@@ -1171,7 +1172,7 @@ export namespace GObject {
1171
1172
  nick: string | null,
1172
1173
  blurb: string | null,
1173
1174
  object_type: GType,
1174
- flags: ParamFlags,
1175
+ flags: ParamFlags | null,
1175
1176
  ): ParamSpec;
1176
1177
  /**
1177
1178
  * Creates a new #GParamSpecParam instance specifying a %G_TYPE_PARAM
@@ -1190,7 +1191,7 @@ export namespace GObject {
1190
1191
  nick: string | null,
1191
1192
  blurb: string | null,
1192
1193
  param_type: GType,
1193
- flags: ParamFlags,
1194
+ flags: ParamFlags | null,
1194
1195
  ): ParamSpec;
1195
1196
  /**
1196
1197
  * Creates a new #GParamSpecPointer instance specifying a pointer property.
@@ -1204,7 +1205,12 @@ export namespace GObject {
1204
1205
  * @param flags flags for the property specified
1205
1206
  * @returns a newly created parameter specification
1206
1207
  */
1207
- function param_spec_pointer(name: string, nick: string | null, blurb: string | null, flags: ParamFlags): ParamSpec;
1208
+ function param_spec_pointer(
1209
+ name: string,
1210
+ nick: string | null,
1211
+ blurb: string | null,
1212
+ flags: ParamFlags | null,
1213
+ ): ParamSpec;
1208
1214
  /**
1209
1215
  * Creates a new #GParamSpecString instance.
1210
1216
  *
@@ -1221,7 +1227,7 @@ export namespace GObject {
1221
1227
  nick: string | null,
1222
1228
  blurb: string | null,
1223
1229
  default_value: string | null,
1224
- flags: ParamFlags,
1230
+ flags: ParamFlags | null,
1225
1231
  ): ParamSpec;
1226
1232
  /**
1227
1233
  * Creates a new #GParamSpecUChar instance specifying a %G_TYPE_UCHAR property.
@@ -1241,7 +1247,7 @@ export namespace GObject {
1241
1247
  minimum: number,
1242
1248
  maximum: number,
1243
1249
  default_value: number,
1244
- flags: ParamFlags,
1250
+ flags: ParamFlags | null,
1245
1251
  ): ParamSpec;
1246
1252
  /**
1247
1253
  * Creates a new #GParamSpecUInt instance specifying a %G_TYPE_UINT property.
@@ -1263,7 +1269,7 @@ export namespace GObject {
1263
1269
  minimum: number,
1264
1270
  maximum: number,
1265
1271
  default_value: number,
1266
- flags: ParamFlags,
1272
+ flags: ParamFlags | null,
1267
1273
  ): ParamSpec;
1268
1274
  /**
1269
1275
  * Creates a new #GParamSpecUInt64 instance specifying a %G_TYPE_UINT64
@@ -1286,7 +1292,7 @@ export namespace GObject {
1286
1292
  minimum: number,
1287
1293
  maximum: number,
1288
1294
  default_value: number,
1289
- flags: ParamFlags,
1295
+ flags: ParamFlags | null,
1290
1296
  ): ParamSpec;
1291
1297
  /**
1292
1298
  * Creates a new #GParamSpecULong instance specifying a %G_TYPE_ULONG
@@ -1309,7 +1315,7 @@ export namespace GObject {
1309
1315
  minimum: number,
1310
1316
  maximum: number,
1311
1317
  default_value: number,
1312
- flags: ParamFlags,
1318
+ flags: ParamFlags | null,
1313
1319
  ): ParamSpec;
1314
1320
  /**
1315
1321
  * Creates a new #GParamSpecUnichar instance specifying a %G_TYPE_UINT
@@ -1329,7 +1335,7 @@ export namespace GObject {
1329
1335
  nick: string | null,
1330
1336
  blurb: string | null,
1331
1337
  default_value: number,
1332
- flags: ParamFlags,
1338
+ flags: ParamFlags | null,
1333
1339
  ): ParamSpec;
1334
1340
  /**
1335
1341
  * Creates a new #GParamSpecVariant instance specifying a #GVariant
@@ -1352,7 +1358,7 @@ export namespace GObject {
1352
1358
  blurb: string | null,
1353
1359
  type: GLib.VariantType,
1354
1360
  default_value: GLib.Variant | null,
1355
- flags: ParamFlags,
1361
+ flags: ParamFlags | null,
1356
1362
  ): ParamSpec;
1357
1363
  /**
1358
1364
  * Registers `name` as the name of a new static type derived
@@ -1634,7 +1640,7 @@ export namespace GObject {
1634
1640
  */
1635
1641
  function signal_handlers_block_matched(
1636
1642
  instance: Object,
1637
- mask: SignalMatchType,
1643
+ mask: SignalMatchType | null,
1638
1644
  signal_id: number,
1639
1645
  detail: GLib.Quark,
1640
1646
  func?: any | null,
@@ -1672,7 +1678,7 @@ export namespace GObject {
1672
1678
  */
1673
1679
  function signal_handlers_disconnect_matched(
1674
1680
  instance: Object,
1675
- mask: SignalMatchType,
1681
+ mask: SignalMatchType | null,
1676
1682
  signal_id: number,
1677
1683
  detail: GLib.Quark,
1678
1684
  func?: any | null,
@@ -1704,7 +1710,7 @@ export namespace GObject {
1704
1710
  */
1705
1711
  function signal_handlers_unblock_matched(
1706
1712
  instance: Object,
1707
- mask: SignalMatchType,
1713
+ mask: SignalMatchType | null,
1708
1714
  signal_id: number,
1709
1715
  detail: GLib.Quark,
1710
1716
  func?: any | null,
@@ -1802,7 +1808,7 @@ export namespace GObject {
1802
1808
  function signal_newv(
1803
1809
  signal_name: string,
1804
1810
  itype: GType,
1805
- signal_flags: SignalFlags,
1811
+ signal_flags: SignalFlags | null,
1806
1812
  class_closure: Closure | null,
1807
1813
  c_marshaller: SignalCMarshaller | null,
1808
1814
  return_type: GType,
@@ -2160,7 +2166,7 @@ export namespace GObject {
2160
2166
  * environment variable.
2161
2167
  * @param debug_flags bitwise combination of #GTypeDebugFlags values for debugging purposes
2162
2168
  */
2163
- function type_init_with_debug_flags(debug_flags: TypeDebugFlags): void;
2169
+ function type_init_with_debug_flags(debug_flags: TypeDebugFlags | null): void;
2164
2170
  /**
2165
2171
  * Adds `prerequisite_type` to the list of prerequisites of `interface_type`.
2166
2172
  * This means that any type implementing `interface_type` must also implement
@@ -2286,7 +2292,12 @@ export namespace GObject {
2286
2292
  * @param flags bitwise combination of #GTypeFlags values
2287
2293
  * @returns the new type identifier or %G_TYPE_INVALID if registration failed
2288
2294
  */
2289
- function type_register_dynamic(parent_type: GType, type_name: string, plugin: TypePlugin, flags: TypeFlags): GType;
2295
+ function type_register_dynamic(
2296
+ parent_type: GType,
2297
+ type_name: string,
2298
+ plugin: TypePlugin,
2299
+ flags: TypeFlags | null,
2300
+ ): GType;
2290
2301
  /**
2291
2302
  * Registers `type_id` as the predefined identifier and `type_name` as the
2292
2303
  * name of a fundamental type. If `type_id` is already registered, or a
@@ -2307,7 +2318,7 @@ export namespace GObject {
2307
2318
  type_name: string,
2308
2319
  info: TypeInfo,
2309
2320
  finfo: TypeFundamentalInfo,
2310
- flags: TypeFlags,
2321
+ flags: TypeFlags | null,
2311
2322
  ): GType;
2312
2323
  /**
2313
2324
  * Registers `type_name` as the name of a new static type derived from
@@ -2321,7 +2332,12 @@ export namespace GObject {
2321
2332
  * @param flags bitwise combination of #GTypeFlags values
2322
2333
  * @returns the new type identifier
2323
2334
  */
2324
- function type_register_static(parent_type: GType, type_name: string, info: TypeInfo, flags: TypeFlags): GType;
2335
+ function type_register_static(
2336
+ parent_type: GType,
2337
+ type_name: string,
2338
+ info: TypeInfo,
2339
+ flags: TypeFlags | null,
2340
+ ): GType;
2325
2341
  /**
2326
2342
  * Attaches arbitrary data to a type.
2327
2343
  * @param type a #GType
@@ -2882,7 +2898,7 @@ export namespace GObject {
2882
2898
  */
2883
2899
  DEEP_DERIVABLE,
2884
2900
  }
2885
- module Binding {
2901
+ namespace Binding {
2886
2902
  // Constructor properties interface
2887
2903
 
2888
2904
  interface ConstructorProps extends Object.ConstructorProps {
@@ -3108,7 +3124,7 @@ export namespace GObject {
3108
3124
  unbind(): void;
3109
3125
  }
3110
3126
 
3111
- module BindingGroup {
3127
+ namespace BindingGroup {
3112
3128
  // Constructor properties interface
3113
3129
 
3114
3130
  interface ConstructorProps extends Object.ConstructorProps {
@@ -3158,7 +3174,7 @@ export namespace GObject {
3158
3174
  * @param target_property the property on @target to bind
3159
3175
  * @param flags the flags used to create the #GBinding
3160
3176
  */
3161
- bind(source_property: string, target: Object, target_property: string, flags: BindingFlags): void;
3177
+ bind(source_property: string, target: Object, target_property: string, flags: BindingFlags | null): void;
3162
3178
  /**
3163
3179
  * Creates a binding between `source_property` on the source object and
3164
3180
  * `target_property` on `target,` allowing you to set the transformation
@@ -3177,7 +3193,7 @@ export namespace GObject {
3177
3193
  source_property: string,
3178
3194
  target: Object,
3179
3195
  target_property: string,
3180
- flags: BindingFlags,
3196
+ flags: BindingFlags | null,
3181
3197
  transform_to?: BindingTransformFunc | null,
3182
3198
  transform_from?: BindingTransformFunc | null,
3183
3199
  ): void;
@@ -3203,7 +3219,7 @@ export namespace GObject {
3203
3219
  source_property: string,
3204
3220
  target: Object,
3205
3221
  target_property: string,
3206
- flags: BindingFlags,
3222
+ flags: BindingFlags | null,
3207
3223
  transform_to?: Closure | null,
3208
3224
  transform_from?: Closure | null,
3209
3225
  ): void;
@@ -3223,7 +3239,7 @@ export namespace GObject {
3223
3239
  set_source(source?: Object | null): void;
3224
3240
  }
3225
3241
 
3226
- module InitiallyUnowned {
3242
+ namespace InitiallyUnowned {
3227
3243
  // Constructor properties interface
3228
3244
 
3229
3245
  interface ConstructorProps extends Object.ConstructorProps {}
@@ -3245,7 +3261,7 @@ export namespace GObject {
3245
3261
  _init(...args: any[]): void;
3246
3262
  }
3247
3263
 
3248
- module Object {
3264
+ namespace Object {
3249
3265
  // Signal callback interfaces
3250
3266
 
3251
3267
  interface Notify {
@@ -3458,7 +3474,12 @@ export namespace GObject {
3458
3474
  * @param flags flags to pass to #GBinding
3459
3475
  * @returns the #GBinding instance representing the binding between the two #GObject instances. The binding is released whenever the #GBinding reference count reaches zero.
3460
3476
  */
3461
- bind_property(source_property: string, target: Object, target_property: string, flags: BindingFlags): Binding;
3477
+ bind_property(
3478
+ source_property: string,
3479
+ target: Object,
3480
+ target_property: string,
3481
+ flags: BindingFlags | null,
3482
+ ): Binding;
3462
3483
  /**
3463
3484
  * Complete version of g_object_bind_property().
3464
3485
  *
@@ -3498,7 +3519,7 @@ export namespace GObject {
3498
3519
  source_property: string,
3499
3520
  target: Object,
3500
3521
  target_property: string,
3501
- flags: BindingFlags,
3522
+ flags: BindingFlags | null,
3502
3523
  transform_to?: BindingTransformFunc | null,
3503
3524
  transform_from?: BindingTransformFunc | null,
3504
3525
  notify?: GLib.DestroyNotify | null,
@@ -3523,7 +3544,7 @@ export namespace GObject {
3523
3544
  source_property: string,
3524
3545
  target: Object,
3525
3546
  target_property: string,
3526
- flags: BindingFlags,
3547
+ flags: BindingFlags | null,
3527
3548
  transform_to: Closure,
3528
3549
  transform_from: Closure,
3529
3550
  ): Binding;
@@ -3773,18 +3794,8 @@ export namespace GObject {
3773
3794
  }
3774
3795
 
3775
3796
  /**
3776
- * `GParamSpec` encapsulates the metadata required to specify parameters, such as `GObject` properties.
3777
- *
3778
- * ## Parameter names
3779
- *
3780
- * A property name consists of one or more segments consisting of ASCII letters
3781
- * and digits, separated by either the `-` or `_` character. The first
3782
- * character of a property name must be a letter. These are the same rules as
3783
- * for signal naming (see [func`GObject`.signal_new]).
3784
- *
3785
- * When creating and looking up a `GParamSpec`, either separator can be
3786
- * used, but they cannot be mixed. Using `-` is considerably more
3787
- * efficient, and is the ‘canonical form’. Using `_` is discouraged.
3797
+ * A GObject parameter specification that defines property characteristics.
3798
+ * See https://gjs.guide/guides/gobject/basics.html#properties for more details.
3788
3799
  */
3789
3800
  abstract class ParamSpec<A = unknown> {
3790
3801
  static $gtype: GType<ParamSpec>;
@@ -3812,134 +3823,281 @@ export namespace GObject {
3812
3823
  * @param name the canonical name of the property
3813
3824
  */
3814
3825
  static is_valid_name(name: string): boolean;
3826
+ /**
3827
+ * Creates a new GParamSpecChar instance specifying a G_TYPE_CHAR property.
3828
+ * @param name The name of the property
3829
+ * @param nick A human readable name for the property
3830
+ * @param blurb A longer description of the property
3831
+ * @param flags The flags for this property (e.g. READABLE, WRITABLE)
3832
+ * @param minimum The minimum value for this property
3833
+ * @param maximum The maximum value for this property
3834
+ * @param defaultValue The default value for this property
3835
+ */
3815
3836
  static ['char'](
3816
3837
  name: string,
3817
- nick: string,
3818
- blurb: string,
3838
+ nick: string | null,
3839
+ blurb: string | null,
3819
3840
  flags: ParamFlags | number,
3820
3841
  minimum: number,
3821
3842
  maximum: number,
3822
3843
  defaultValue: number,
3823
3844
  ): ParamSpec<number>;
3845
+ /**
3846
+ * Creates a new GParamSpecUChar instance specifying a G_TYPE_UCHAR property.
3847
+ * @param name The name of the property
3848
+ * @param nick A human readable name for the property
3849
+ * @param blurb A longer description of the property
3850
+ * @param flags The flags for this property (e.g. READABLE, WRITABLE)
3851
+ * @param minimum The minimum value for this property
3852
+ * @param maximum The maximum value for this property
3853
+ * @param defaultValue The default value for this property
3854
+ */
3824
3855
  static uchar(
3825
3856
  name: string,
3826
- nick: string,
3827
- blurb: string,
3857
+ nick: string | null,
3858
+ blurb: string | null,
3828
3859
  flags: ParamFlags | number,
3829
3860
  minimum: number,
3830
3861
  maximum: number,
3831
3862
  defaultValue: number,
3832
3863
  ): ParamSpec<number>;
3864
+ /**
3865
+ * Creates a new GParamSpecInt instance specifying a G_TYPE_INT property.
3866
+ * @param name The name of the property
3867
+ * @param nick A human readable name for the property
3868
+ * @param blurb A longer description of the property
3869
+ * @param flags The flags for this property (e.g. READABLE, WRITABLE)
3870
+ * @param minimum The minimum value for this property
3871
+ * @param maximum The maximum value for this property
3872
+ * @param defaultValue The default value for this property
3873
+ */
3833
3874
  static int(
3834
3875
  name: string,
3835
- nick: string,
3836
- blurb: string,
3876
+ nick: string | null,
3877
+ blurb: string | null,
3837
3878
  flags: ParamFlags | number,
3838
3879
  minimum: number,
3839
3880
  maximum: number,
3840
3881
  defaultValue: number,
3841
3882
  ): ParamSpec<number>;
3883
+ /**
3884
+ * Creates a new GParamSpecUInt instance specifying a G_TYPE_UINT property.
3885
+ * @param name The name of the property
3886
+ * @param nick A human readable name for the property
3887
+ * @param blurb A longer description of the property
3888
+ * @param flags The flags for this property (e.g. READABLE, WRITABLE)
3889
+ * @param minimum The minimum value for this property
3890
+ * @param maximum The maximum value for this property
3891
+ * @param defaultValue The default value for this property
3892
+ */
3842
3893
  static uint(
3843
3894
  name: string,
3844
- nick: string,
3845
- blurb: string,
3895
+ nick: string | null,
3896
+ blurb: string | null,
3846
3897
  flags: ParamFlags | number,
3847
3898
  minimum: number,
3848
3899
  maximum: number,
3849
3900
  defaultValue: number,
3850
3901
  ): ParamSpec<number>;
3902
+ /**
3903
+ * Creates a new GParamSpecLong instance specifying a G_TYPE_LONG property.
3904
+ * @param name The name of the property
3905
+ * @param nick A human readable name for the property
3906
+ * @param blurb A longer description of the property
3907
+ * @param flags The flags for this property (e.g. READABLE, WRITABLE)
3908
+ * @param minimum The minimum value for this property
3909
+ * @param maximum The maximum value for this property
3910
+ * @param defaultValue The default value for this property
3911
+ */
3851
3912
  static long(
3852
3913
  name: string,
3853
- nick: string,
3854
- blurb: string,
3914
+ nick: string | null,
3915
+ blurb: string | null,
3855
3916
  flags: ParamFlags | number,
3856
3917
  minimum: number,
3857
3918
  maximum: number,
3858
3919
  defaultValue: number,
3859
3920
  ): ParamSpec<number>;
3921
+ /**
3922
+ * Creates a new GParamSpecULong instance specifying a G_TYPE_ULONG property.
3923
+ * @param name The name of the property
3924
+ * @param nick A human readable name for the property
3925
+ * @param blurb A longer description of the property
3926
+ * @param flags The flags for this property (e.g. READABLE, WRITABLE)
3927
+ * @param minimum The minimum value for this property
3928
+ * @param maximum The maximum value for this property
3929
+ * @param defaultValue The default value for this property
3930
+ */
3860
3931
  static ulong(
3861
3932
  name: string,
3862
- nick: string,
3863
- blurb: string,
3933
+ nick: string | null,
3934
+ blurb: string | null,
3864
3935
  flags: ParamFlags | number,
3865
3936
  minimum: number,
3866
3937
  maximum: number,
3867
3938
  defaultValue: number,
3868
3939
  ): ParamSpec<number>;
3940
+ /**
3941
+ * Creates a new GParamSpecInt64 instance specifying a G_TYPE_INT64 property.
3942
+ * @param name The name of the property
3943
+ * @param nick A human readable name for the property
3944
+ * @param blurb A longer description of the property
3945
+ * @param flags The flags for this property (e.g. READABLE, WRITABLE)
3946
+ * @param minimum The minimum value for this property
3947
+ * @param maximum The maximum value for this property
3948
+ * @param defaultValue The default value for this property
3949
+ */
3869
3950
  static int64(
3870
3951
  name: string,
3871
- nick: string,
3872
- blurb: string,
3952
+ nick: string | null,
3953
+ blurb: string | null,
3873
3954
  flags: ParamFlags | number,
3874
3955
  minimum: number,
3875
3956
  maximum: number,
3876
3957
  defaultValue: number,
3877
3958
  ): ParamSpec<number>;
3959
+ /**
3960
+ * Creates a new GParamSpecUInt64 instance specifying a G_TYPE_UINT64 property.
3961
+ * @param name The name of the property
3962
+ * @param nick A human readable name for the property
3963
+ * @param blurb A longer description of the property
3964
+ * @param flags The flags for this property (e.g. READABLE, WRITABLE)
3965
+ * @param minimum The minimum value for this property
3966
+ * @param maximum The maximum value for this property
3967
+ * @param defaultValue The default value for this property
3968
+ */
3878
3969
  static uint64(
3879
3970
  name: string,
3880
- nick: string,
3881
- blurb: string,
3971
+ nick: string | null,
3972
+ blurb: string | null,
3882
3973
  flags: ParamFlags | number,
3883
3974
  minimum: number,
3884
3975
  maximum: number,
3885
3976
  defaultValue: number,
3886
3977
  ): ParamSpec<number>;
3978
+ /**
3979
+ * Creates a new GParamSpecFloat instance specifying a G_TYPE_FLOAT property.
3980
+ * @param name The name of the property
3981
+ * @param nick A human readable name for the property
3982
+ * @param blurb A longer description of the property
3983
+ * @param flags The flags for this property (e.g. READABLE, WRITABLE)
3984
+ * @param minimum The minimum value for this property
3985
+ * @param maximum The maximum value for this property
3986
+ * @param defaultValue The default value for this property
3987
+ */
3887
3988
  static float(
3888
3989
  name: string,
3889
- nick: string,
3890
- blurb: string,
3990
+ nick: string | null,
3991
+ blurb: string | null,
3891
3992
  flags: ParamFlags | number,
3892
3993
  minimum: number,
3893
3994
  maximum: number,
3894
3995
  defaultValue: number,
3895
3996
  ): ParamSpec<number>;
3997
+ /**
3998
+ * Creates a new GParamSpecBoolean instance specifying a G_TYPE_BOOLEAN property. In many cases, it may be more appropriate to use an enum with g_param_spec_enum(), both to improve code clarity by using explicitly named values, and to allow for more values to be added in future without breaking API.
3999
+ * @param name The name of the property
4000
+ * @param nick A human readable name for the property
4001
+ * @param blurb A longer description of the property
4002
+ * @param flags The flags for this property (e.g. READABLE, WRITABLE)
4003
+ * @param defaultValue The default value for this property
4004
+ */
3896
4005
  static ['boolean'](
3897
4006
  name: string,
3898
- nick: string,
3899
- blurb: string,
4007
+ nick: string | null,
4008
+ blurb: string | null,
3900
4009
  flags: ParamFlags | number,
3901
4010
  defaultValue: boolean,
3902
4011
  ): ParamSpec<boolean>;
4012
+ /**
4013
+ * Creates a new GParamSpecEnum instance specifying a G_TYPE_ENUM property.
4014
+ * @param name The name of the property
4015
+ * @param nick A human readable name for the property
4016
+ * @param blurb A longer description of the property
4017
+ * @param flags The flags for this property (e.g. READABLE, WRITABLE)
4018
+ * @param enumType
4019
+ * @param defaultValue The default value for this property
4020
+ */
3903
4021
  static ['enum']<T>(
3904
4022
  name: string,
3905
- nick: string,
3906
- blurb: string,
4023
+ nick: string | null,
4024
+ blurb: string | null,
3907
4025
  flags: ParamFlags | number,
3908
4026
  enumType: GType<T> | { $gtype: GType<T> },
3909
4027
  defaultValue: any,
3910
4028
  ): ParamSpec<T>;
4029
+ /**
4030
+ * Creates a new GParamSpecDouble instance specifying a G_TYPE_DOUBLE property.
4031
+ * @param name The name of the property
4032
+ * @param nick A human readable name for the property
4033
+ * @param blurb A longer description of the property
4034
+ * @param flags The flags for this property (e.g. READABLE, WRITABLE)
4035
+ * @param minimum The minimum value for this property
4036
+ * @param maximum The maximum value for this property
4037
+ * @param defaultValue The default value for this property
4038
+ */
3911
4039
  static double(
3912
4040
  name: string,
3913
- nick: string,
3914
- blurb: string,
4041
+ nick: string | null,
4042
+ blurb: string | null,
3915
4043
  flags: ParamFlags | number,
3916
4044
  minimum: number,
3917
4045
  maximum: number,
3918
4046
  defaultValue: number,
3919
4047
  ): ParamSpec<number>;
4048
+ /**
4049
+ * Creates a new GParamSpecString instance specifying a G_TYPE_STRING property.
4050
+ * @param name The name of the property
4051
+ * @param nick A human readable name for the property
4052
+ * @param blurb A longer description of the property
4053
+ * @param flags The flags for this property (e.g. READABLE, WRITABLE)
4054
+ * @param defaultValue The default value for this property
4055
+ */
3920
4056
  static string(
3921
4057
  name: string,
3922
- nick: string,
3923
- blurb: string,
4058
+ nick: string | null,
4059
+ blurb: string | null,
3924
4060
  flags: ParamFlags | number,
3925
4061
  defaultValue: string,
3926
4062
  ): ParamSpec<string>;
4063
+ /**
4064
+ * Creates a new GParamSpecBoxed instance specifying a G_TYPE_BOXED derived property.
4065
+ * @param name The name of the property
4066
+ * @param nick A human readable name for the property
4067
+ * @param blurb A longer description of the property
4068
+ * @param flags The flags for this property (e.g. READABLE, WRITABLE)
4069
+ * @param boxedType
4070
+ */
3927
4071
  static boxed<T>(
3928
4072
  name: string,
3929
- nick: string,
3930
- blurb: string,
4073
+ nick: string | null,
4074
+ blurb: string | null,
3931
4075
  flags: ParamFlags | number,
3932
4076
  boxedType: GType<T> | { $gtype: GType<T> },
3933
4077
  ): ParamSpec<T>;
3934
4078
  static object<T>(
3935
4079
  name: string,
3936
- nick: string,
3937
- blurb: string,
4080
+ nick: string | null,
4081
+ blurb: string | null,
3938
4082
  flags: string,
3939
4083
  objectType: GType<T> | { $gtype: GType<T> },
3940
4084
  ): ParamSpec<T>;
3941
- static param(name: string, nick: string, blurb: string, flags: ParamFlags | number, paramType: any): ParamSpec;
3942
- static jsobject<T>(name: string, nick: string, blurb: string, flags: any): ParamSpec<T>;
4085
+ /**
4086
+ * Creates a new GParamSpecParam instance specifying a G_TYPE_PARAM property.
4087
+ * @param name The name of the property
4088
+ * @param nick A human readable name for the property
4089
+ * @param blurb A longer description of the property
4090
+ * @param flags The flags for this property (e.g. READABLE, WRITABLE)
4091
+ * @param paramType
4092
+ */
4093
+ static param(
4094
+ name: string,
4095
+ nick: string | null,
4096
+ blurb: string | null,
4097
+ flags: ParamFlags | number,
4098
+ paramType: any,
4099
+ ): ParamSpec;
4100
+ static jsobject<T>(name: string, nick: string | null, blurb: string | null, flags: any): ParamSpec<T>;
3943
4101
 
3944
4102
  // Virtual methods
3945
4103
 
@@ -4059,7 +4217,7 @@ export namespace GObject {
4059
4217
  override(name: string, oclass: Object | Function | GType): void;
4060
4218
  }
4061
4219
 
4062
- module SignalGroup {
4220
+ namespace SignalGroup {
4063
4221
  // Signal callback interfaces
4064
4222
 
4065
4223
  interface Bind {
@@ -4168,7 +4326,12 @@ export namespace GObject {
4168
4326
  * @param notify function to be called when disposing of @self
4169
4327
  * @param flags the flags used to create the signal connection
4170
4328
  */
4171
- connect_data(detailed_signal: string, c_handler: Callback, notify: ClosureNotify, flags: ConnectFlags): void;
4329
+ connect_data(
4330
+ detailed_signal: string,
4331
+ c_handler: Callback,
4332
+ notify: ClosureNotify,
4333
+ flags: ConnectFlags | null,
4334
+ ): void;
4172
4335
  /**
4173
4336
  * Connects `c_handler` to the signal `detailed_signal`
4174
4337
  * on the target instance of `self`.
@@ -4205,7 +4368,7 @@ export namespace GObject {
4205
4368
  unblock(): void;
4206
4369
  }
4207
4370
 
4208
- module TypeModule {
4371
+ namespace TypeModule {
4209
4372
  // Constructor properties interface
4210
4373
 
4211
4374
  interface ConstructorProps extends Object.ConstructorProps, TypePlugin.ConstructorProps {}
@@ -4342,7 +4505,7 @@ export namespace GObject {
4342
4505
  * @param flags flags field providing details about the type
4343
4506
  * @returns the new or existing type ID
4344
4507
  */
4345
- register_type(parent_type: GType, type_name: string, type_info: TypeInfo, flags: TypeFlags): GType;
4508
+ register_type(parent_type: GType, type_name: string, type_info: TypeInfo, flags: TypeFlags | null): GType;
4346
4509
  /**
4347
4510
  * Sets the name for a #GTypeModule
4348
4511
  * @param name a human-readable name to use in error messages.
@@ -4426,7 +4589,12 @@ export namespace GObject {
4426
4589
  * @param flags flags to pass to #GBinding
4427
4590
  * @returns the #GBinding instance representing the binding between the two #GObject instances. The binding is released whenever the #GBinding reference count reaches zero.
4428
4591
  */
4429
- bind_property(source_property: string, target: Object, target_property: string, flags: BindingFlags): Binding;
4592
+ bind_property(
4593
+ source_property: string,
4594
+ target: Object,
4595
+ target_property: string,
4596
+ flags: BindingFlags | null,
4597
+ ): Binding;
4430
4598
  /**
4431
4599
  * Complete version of g_object_bind_property().
4432
4600
  *
@@ -4466,7 +4634,7 @@ export namespace GObject {
4466
4634
  source_property: string,
4467
4635
  target: Object,
4468
4636
  target_property: string,
4469
- flags: BindingFlags,
4637
+ flags: BindingFlags | null,
4470
4638
  transform_to?: BindingTransformFunc | null,
4471
4639
  transform_from?: BindingTransformFunc | null,
4472
4640
  notify?: GLib.DestroyNotify | null,
@@ -6442,7 +6610,7 @@ export namespace GObject {
6442
6610
  _init(...args: any[]): void;
6443
6611
  }
6444
6612
 
6445
- module TypePlugin {
6613
+ namespace TypePlugin {
6446
6614
  // Constructor properties interface
6447
6615
 
6448
6616
  interface ConstructorProps extends Object.ConstructorProps {}
@@ -6487,7 +6655,9 @@ export namespace GObject {
6487
6655
  use(): void;
6488
6656
  }
6489
6657
 
6490
- export const TypePlugin: TypePluginNamespace;
6658
+ export const TypePlugin: TypePluginNamespace & {
6659
+ new (): TypePlugin; // This allows `obj instanceof TypePlugin`
6660
+ };
6491
6661
 
6492
6662
  type SignalCMarshaller = ClosureMarshal;
6493
6663
  type SignalCVaMarshaller = unknown;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@girs/gobject-2.0",
3
- "version": "2.82.2-4.0.0-beta.18",
4
- "description": "GJS TypeScript type definitions for GObject-2.0, generated from library version 2.82.2",
3
+ "version": "2.82.4-4.0.0-beta.20",
4
+ "description": "GJS TypeScript type definitions for GObject-2.0, generated from library version 2.82.4",
5
5
  "type": "module",
6
6
  "module": "gobject-2.0.js",
7
7
  "main": "gobject-2.0.js",
@@ -31,8 +31,8 @@
31
31
  "test": "tsc --project tsconfig.json"
32
32
  },
33
33
  "dependencies": {
34
- "@girs/gjs": "^4.0.0-beta.18",
35
- "@girs/glib-2.0": "^2.82.2-4.0.0-beta.18"
34
+ "@girs/gjs": "^4.0.0-beta.20",
35
+ "@girs/glib-2.0": "^2.82.4-4.0.0-beta.20"
36
36
  },
37
37
  "devDependencies": {
38
38
  "typescript": "*"
package/tsconfig.json CHANGED
@@ -15,7 +15,9 @@
15
15
  "removeComments": false,
16
16
  "inlineSourceMap": false,
17
17
  "inlineSources": false,
18
- "newLine": "LF"
18
+ "newLine": "LF",
19
+ // Show diagnostics
20
+ "diagnostics": true
19
21
  },
20
22
  "include": ["./gobject-2.0.d.ts"]
21
23
  }