@overwolf/ow-electron-packages-types 1.1.2-beta.1 → 1.1.2-beta.3

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 (2) hide show
  1. package/package.json +4 -1
  2. package/types.d.ts +35 -34
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@overwolf/ow-electron-packages-types",
3
- "version": "1.1.2-beta.1",
3
+ "version": "1.1.2-beta.3",
4
4
  "description": "Type definition file for autocompletion and documentation purposes for ow-electron packages",
5
5
  "license": "MIT",
6
6
  "types": "types.d.ts",
@@ -31,6 +31,9 @@
31
31
  "types": "./gep-supported-games.d.ts"
32
32
  }
33
33
  },
34
+ "scripts": {
35
+ "combine": "node combine-dts.js ./modules"
36
+ },
34
37
  "dependencies": {
35
38
  "glob": "^13.0.0"
36
39
  }
package/types.d.ts CHANGED
@@ -1,18 +1,18 @@
1
- import { overwolf } from '@overwolf/ow-electron';
2
- import type {
3
- BrowserWindow,
4
- BrowserWindowConstructorOptions,
5
- Size,
6
- WebContents,
7
- Display,
8
- Rectangle
9
- } from 'electron';
10
-
11
- import { EventEmitter } from 'events';
12
-
13
- // -----------------------------------------------------------------------------
14
-
15
- // --- modules\utility.d.ts ---
1
+ import { overwolf } from '@overwolf/ow-electron';
2
+ import type {
3
+ BrowserWindow,
4
+ BrowserWindowConstructorOptions,
5
+ Size,
6
+ WebContents,
7
+ Display,
8
+ Rectangle
9
+ } from 'electron';
10
+
11
+ import { EventEmitter } from 'events';
12
+
13
+ // -----------------------------------------------------------------------------
14
+
15
+ // --- modules\utility.d.ts ---
16
16
  /**
17
17
  * @packageDocumentation
18
18
  *
@@ -146,9 +146,9 @@ interface IOverwolfUtilityApi {
146
146
  */
147
147
  on(eventName: 'game-exit', listener: (gameInfo: GameInfo) => void): this;
148
148
  }
149
-
150
-
151
- // --- modules\recorder.d.ts ---
149
+
150
+
151
+ // --- modules\recorder.d.ts ---
152
152
  /**
153
153
  *
154
154
  * The Overwolf Electron recording APIs integrate recording into the Overwolf Electron framework allowing you to record both audio and video.
@@ -4367,10 +4367,11 @@ interface IOverwolfRecordingApi {
4367
4367
  /**
4368
4368
  * Queries supported encoders, audio/video devices, and configuration options.
4369
4369
  *
4370
+ * @param overrideCache If `true`, bypasses cached result and queries OBS directly.
4370
4371
  * @returns A promise that resolves to the full recording capability information.
4371
4372
  * @see {@link RecordingInformation}
4372
4373
  */
4373
- queryInformation(): Promise<RecordingInformation>;
4374
+ queryInformation(overrideCache?: boolean): Promise<RecordingInformation>;
4374
4375
 
4375
4376
  /**
4376
4377
  * Creates a capture settings builder instance to configure video/audio sources.
@@ -4461,7 +4462,7 @@ interface IOverwolfRecordingApi {
4461
4462
  *
4462
4463
  * @param filter Filtering rules for which games to track.
4463
4464
  */
4464
- registerGames(filter: GamesFilter): void;
4465
+ registerGames(filter: GamesFilter): Promise<void>;
4465
4466
 
4466
4467
  /**
4467
4468
  * Updates runtime settings for an audio device while recording.
@@ -4512,9 +4513,9 @@ interface IOverwolfRecordingApi {
4512
4513
  */
4513
4514
  on(eventName: 'stats', listener: (args: RecorderStats) => void): this;
4514
4515
  }
4515
-
4516
-
4517
- // --- modules\packages.d.ts ---
4516
+
4517
+
4518
+ // --- modules\packages.d.ts ---
4518
4519
  // -----------------------------------------------------------------------------
4519
4520
  //
4520
4521
  /**
@@ -4576,9 +4577,9 @@ interface OWPackages extends overwolf.packages.OverwolfPackageManager {
4576
4577
  */
4577
4578
  gep: OverwolfGameEventPackage;
4578
4579
  }
4579
-
4580
-
4581
- // --- modules\overlay.d.ts ---
4580
+
4581
+
4582
+ // --- modules\overlay.d.ts ---
4582
4583
  /**
4583
4584
  * APIs for controlling and creating overlays in games. Overlay is the ability to show windows on top of the current game window.
4584
4585
  *
@@ -5757,9 +5758,9 @@ interface IOverwolfOverlayApi extends EventEmitter {
5757
5758
  listener: (info: GameInputInterception) => void
5758
5759
  ): this;
5759
5760
  }
5760
-
5761
-
5762
- // --- modules\gep.d.ts ---
5761
+
5762
+
5763
+ // --- modules\gep.d.ts ---
5763
5764
  /**
5764
5765
  * The *Game Events Provider* (GEP) APIs allow your app to subscribe to real-time in-game events and info updates
5765
5766
  * from supported games. GEP detects when a supported game launches, tracks gameplay state, and emits structured
@@ -5832,7 +5833,7 @@ interface OverwolfGameEventPackage extends NodeJS.EventEmitter {
5832
5833
  getSupportedGames(): Promise<{
5833
5834
  name: string;
5834
5835
  id: number;
5835
- }>;
5836
+ }[]>;
5836
5837
 
5837
5838
  /**
5838
5839
  * Returns the target game's current Game Info.
@@ -5958,9 +5959,9 @@ interface OverwolfGameEventPackage extends NodeJS.EventEmitter {
5958
5959
  */
5959
5960
  category: string;
5960
5961
  }
5961
- }
5962
-
5963
- // --- modules\crn.d.ts ---
5962
+ }
5963
+
5964
+ // --- modules\crn.d.ts ---
5964
5965
  /**
5965
5966
  * The *Content Recommendation Notification* (CRN) APIs give you tools to help manage the content notification settings in your app.
5966
5967
  *
@@ -6097,4 +6098,4 @@ export interface IOverwolfCRNApi {
6097
6098
  eventName: 'notification-action',
6098
6099
  listener: (event: CRNActionType) => void
6099
6100
  ): this;
6100
- }
6101
+ }