Merge pull request #25 from swsnr/gnome46/scrutinize-more-types

Mark event emitter and popup menu for GNOME 46

Author: JumpLink

packages/gnome-shell/src/misc/signals.d.ts

@@ -13,15 +13,15 @@ type SignalMap<K> = {
  * @example
  * ```ts
  * const Signals = imports.signals;
- * 
+ *
  * // Define an interface with the same name of your class to make the methods known
  * interface Events extends Signals.Methods {}
- * 
+ *
  * class Events {}
  * Signals.addSignalMethods(Events.prototype);
- * 
+ *
  * const events = new Events();
- * 
+ *
  * // Typescript will not complain here
  * events.emit("test-signal", "test argument");
  * ```
@@ -30,21 +30,21 @@ export interface SignalMethods<S extends SignalMap<S> = any> {
     /**
      * Connects a callback to a signal for an object. Pass the returned ID to
      * `disconnect()` to remove the handler.
-     * 
+     *
      * If `callback` returns `true`, emission will stop and no other handlers will be
      * invoked.
-     * 
+     *
      * > Warning: Unlike GObject signals, `this` within a signal callback will always
      * > refer to the global object (ie. `globalThis`).
-     * 
+     *
      * @param sigName A signal name
      * @param callback A callback function
      * @returns A handler ID
      */
     connect<Name extends keyof S>(sigName: Name, callback: (self: this, ...args: S[Name]) => boolean | undefined): number;
     /**
      * Emits a signal for an object. Emission stops if a signal handler returns `true`.
-     * 
+     *
      * Unlike GObject signals, it is not necessary to declare signals or define their
      * signature. Simply call `emit()` with whatever signal name you wish, with
      * whatever arguments you wish.
@@ -71,6 +71,9 @@ export interface SignalMethods<S extends SignalMap<S> = any> {
 
 export interface EventEmitter<S extends SignalMap<S> = any> extends SignalMethods<S> {}
 
+/**
+ * @version 46
+ */
 export class EventEmitter<S extends SignalMap<S> = any> {
     connectObject(...args: any[]): number // TODO: return type is return type of imports.misc.signalTracker.connectObject
 
@@ -79,4 +82,4 @@ export class EventEmitter<S extends SignalMap<S> = any> {
     connect_object(...args: any[]): ReturnType<typeof this.connectObject>
 
     disconnect_object(...args: any[]): ReturnType<typeof this.disconnectObject>
-}
+}

packages/gnome-shell/src/ui/popupMenu.d.ts

@@ -221,6 +221,9 @@ export namespace PopupSubMenu {
     interface SignalMap extends PopupMenuBase.SignalMap {}
 }
 
+/**
+ * @version 46
+ */
 export class PopupSubMenu<S extends Signals.SignalMap<S> = PopupSubMenu.SignalMap> extends PopupMenuBase<S> {
     actor: St.ScrollView;