From 630d9e3808f5558ae79001ee8e71e89e7f57ad91 Mon Sep 17 00:00:00 2001 From: ricewind012 <58827198+ricewind012@users.noreply.github.com> Date: Sun, 23 Jun 2024 12:00:14 +0000 Subject: [PATCH] docs(SteamClient): remove duplicate types --- src/deck-components/steam-client/App.ts | 426 ++++++++---------- src/deck-components/steam-client/Auth.ts | 4 +- src/deck-components/steam-client/Broadcast.ts | 27 +- src/deck-components/steam-client/Browser.ts | 11 +- .../steam-client/ClientNotifications.ts | 10 +- src/deck-components/steam-client/Cloud.ts | 12 +- .../steam-client/CommunityItems.ts | 2 +- src/deck-components/steam-client/Console.ts | 15 +- src/deck-components/steam-client/Downloads.ts | 43 +- .../steam-client/FamilySharing.ts | 6 +- .../steam-client/FriendSettings.ts | 10 +- src/deck-components/steam-client/Friends.ts | 20 +- src/deck-components/steam-client/GameNotes.ts | 2 +- .../steam-client/GameSessions.ts | 20 +- src/deck-components/steam-client/Input.ts | 82 ++-- .../steam-client/InstallFolder.ts | 53 +-- src/deck-components/steam-client/Installs.ts | 42 +- src/deck-components/steam-client/Messaging.ts | 4 +- src/deck-components/steam-client/Music.ts | 26 +- .../steam-client/Notifications.ts | 4 +- src/deck-components/steam-client/OpenVR.ts | 32 +- src/deck-components/steam-client/Overlay.ts | 37 +- src/deck-components/steam-client/Parental.ts | 15 +- .../steam-client/RemotePlay.ts | 44 +- .../steam-client/Screenshots.ts | 56 ++- .../steam-client/ServerBrowser.ts | 103 ++--- src/deck-components/steam-client/Settings.ts | 20 +- .../steam-client/SharedConnection.ts | 8 +- src/deck-components/steam-client/Stats.ts | 2 +- .../steam-client/SteamChina.ts | 2 +- src/deck-components/steam-client/Storage.ts | 2 +- src/deck-components/steam-client/Streaming.ts | 36 +- src/deck-components/steam-client/UI.ts | 18 +- src/deck-components/steam-client/URL.ts | 10 +- src/deck-components/steam-client/Updates.ts | 6 +- src/deck-components/steam-client/User.ts | 40 +- src/deck-components/steam-client/WebChat.ts | 37 +- .../steam-client/WebUITransport.ts | 2 +- src/deck-components/steam-client/Window.ts | 61 +-- .../browser-view/BrowserViewPopup.ts | 60 +-- .../steam-client/browser-view/index.ts | 2 +- src/deck-components/steam-client/index.ts | 2 +- .../steam-client/system/Audio.ts | 74 +-- .../steam-client/system/AudioDevice.ts | 6 +- .../steam-client/system/Bluetooth.ts | 48 +- .../steam-client/system/Devkit.ts | 4 +- .../steam-client/system/Display.ts | 2 +- .../steam-client/system/DisplayManager.ts | 4 +- .../steam-client/system/Dock.ts | 4 +- .../steam-client/system/Perf.ts | 8 +- .../steam-client/system/Report.ts | 2 +- src/deck-components/steam-client/system/UI.ts | 6 +- .../steam-client/system/index.ts | 21 +- .../steam-client/system/network/Device.ts | 2 +- .../steam-client/system/network/index.ts | 12 +- 55 files changed, 737 insertions(+), 870 deletions(-) diff --git a/src/deck-components/steam-client/App.ts b/src/deck-components/steam-client/App.ts index 16cc1524..8b01994d 100644 --- a/src/deck-components/steam-client/App.ts +++ b/src/deck-components/steam-client/App.ts @@ -7,86 +7,79 @@ import {FilePrivacyState, Screenshot} from "./Screenshots"; export interface Apps { /** * Adds a non-Steam application shortcut to the local Steam library. - * @param {string} appName - The name of the non-Steam application. - * @param {string} executablePath - The path to the executable file of the non-Steam application. - * @param {string} directory - The working directory for the non-Steam application. - * @param {string} launchOptions - Options to be passed when launching the non-Steam application. - * @returns {Promise} - A Promise that resolves to a unique AppID assigned to the added non-Steam application shortcut. + * @param appName The name of the non-Steam application. + * @param executablePath The path to the executable file of the non-Steam application. + * @param directory The working directory for the non-Steam application. + * @param launchOptions Options to be passed when launching the non-Steam application. + * @returns A Promise that resolves to a unique AppID assigned to the added non-Steam application shortcut. */ AddShortcut(appName: string, executablePath: string, directory: string, launchOptions: string): Promise; /** * Adds user tags to specified apps in the Steam library. - * @param {number[]} appIds - The IDs of the apps to which user tags will be added. - * @param {string} userTag - The user tag to be added. - * @returns {void} + * @param appIds The IDs of the apps to which user tags will be added. + * @param userTag The user tag to be added. * @remarks This function modifies the "/userdata//7/remote/sharedconfig.vdf" file. */ AddUserTagToApps(appIds: number[], userTag: string): void; /** * Backups an app to the specified path. - * @param {number} appId - The ID of the application to back up. - * @param {string} backupToPath - The path to store the backup. - * @returns {number} A Promise that resolves to a number. This value may be "20" for backup busy and "0" for success. + * @param appId The ID of the application to back up. + * @param backupToPath The path to store the backup. + * @returns A Promise that resolves to a number. This value may be "20" for backup busy and "0" for success. */ BackupFilesForApp(appId: number, backupToPath: string): Promise; /** * Opens the screenshot folder for a specific app. - * @param {string} appId - The ID of the app to browse screenshots for. - * @param {number} handle - The screenshot handle to use. - * @returns {void} + * @param appId The ID of the app to browse screenshots for. + * @param handle The screenshot handle to use. */ BrowseScreenshotForApp(appId: string, handle: number): void; /** * Opens the screenshot folder for a specific app. - * @param {string} appId - The ID of the app to browse screenshots for. - * @returns {void} + * @param appId The ID of the app to browse screenshots for. */ BrowseScreenshotsForApp(appId: string): void; /** * Cancels the current backup process. - * @returns {void} */ CancelBackup(): void; /** * Cancels a specific game action. - * @param {number} gameActionId - The ID of the game action to cancel. - * @returns {void} + * @param gameActionId The ID of the game action to cancel. */ CancelGameAction(gameActionId: number): void; /** * Cancels the launch of an application with the specified ID. - * @param {string} appId - The ID of the application whose launch is to be canceled. - * @returns {void} + * @param appId The ID of the application whose launch is to be canceled. */ CancelLaunch(appId: string): void; /** * Clears existing user tags on a specified application and sets new user tags. - * @param {number} appId - The ID of the application to clear and set user tags for. - * @param {string[]} userTags - An array of user tags to set for the application. - * @returns {void} + * @param appId The ID of the application to clear and set user tags for. + * @param userTags An array of user tags to set for the application. * @remarks This function modifies the "/userdata//7/remote/sharedconfig.vdf" file. */ ClearAndSetUserTagsOnApp(appId: number, userTags: string[]): void; /** * Clears the custom artwork for a given application. - * @param {number} appId - The ID of the application to clear custom artwork for. - * @param {AppArtworkAssetType} assetType - The type of artwork to clear. + * @param appId The ID of the application to clear custom artwork for. + * @param assetType The type of artwork to clear. */ ClearCustomArtworkForApp(appId: number, assetType: AppArtworkAssetType): Promise; /** * Clears the custom logo position for a specific application. - * @param {number} appId - The ID of the application. - * @returns {Promise} - A Promise that resolves once the custom logo position is cleared. + * @param appId The ID of the application. + * @returns A Promise that resolves once the custom logo position is cleared. */ ClearCustomLogoPositionForApp(appId: number): Promise; @@ -94,71 +87,67 @@ export interface Apps { /** * Clears user tags on a list of specified applications. - * @param {number[]} appIds - An array of application IDs for which to clear user tags. - * @returns {void} + * @param appIds An array of application IDs for which to clear user tags. * @remarks This function modifies the "/userdata//7/remote/sharedconfig.vdf" file. */ ClearUserTagsOnApps(appIds: number[]): void; /** * Continues a specific game action. - * @param {number} gameActionId - The ID of the game action to continue. - * @param {string} actionType - The type of action to perform during continuation. - * @returns {void} + * @param gameActionId The ID of the game action to continue. + * @param actionType The type of action to perform during continuation. * @remarks actionType - "SkipShaders", "skip", "ShowDurationControl" todo: */ ContinueGameAction(gameActionId: number, actionType: string): void; /** * Creates a Steam application shortcut on the desktop. - * @param {number} appId - The ID of the application for which to create a desktop shortcut. - * @returns {void} + * @param appId The ID of the application for which to create a desktop shortcut. */ CreateDesktopShortcutForApp(appId: number): void; /** * Download a workshop item. - * @param {number} appId - The ID of the application. - * @param {string} itemId - The ID of the workshop item. - * @param {boolean} param1 - Additional parameter (exact usage may vary). - * @returns {void} + * @param appId The ID of the application. + * @param itemId The ID of the workshop item. + * @param param1 Additional parameter (exact usage may vary). */ DownloadWorkshopItem(appId: number, itemId: string, param1: boolean): void; /** * Retrieves achievements within a specified time range for a given app. - * @param {number} appId - The ID of the application. - * @param {number} start - The start of the time range as a Unix timestamp. - * @param {number} end - The end of the time range as a Unix timestamp. - * @returns {Promise} - A Promise that resolves to an array of AppAchievement objects. + * @param appId The ID of the application. + * @param start The start of the time range as a Unix timestamp. + * @param end The end of the time range as a Unix timestamp. + * @returns A Promise that resolves to an array of AppAchievement objects. */ GetAchievementsInTimeRange(appId: number, start: number, end: number): Promise; /** * Retrieves a list of active game actions, such as launching an application. - * @returns {Promise} A Promise that resolves to an array of active game actions. + * @returns A Promise that resolves to an array of active game actions. */ GetActiveGameActions(): Promise; /** * Retrieves a list of available compatibility tools for a specific application. - * @param {number} appId - The ID of the application to retrieve compatibility tools for. - * @returns {Promise} A Promise that resolves to an array of CompatibilityToolInfo objects. + * @param appId The ID of the application to retrieve compatibility tools for. + * @returns A Promise that resolves to an array of CompatibilityToolInfo objects. */ GetAvailableCompatTools(appId: number): Promise; /** * Represents a function to retrieve the name of the application in a backup folder. - * @param {string} appBackupPath - The path to the application's backup folder. - * @returns {Promise} - A Promise that resolves to the name of the application in the backup folder, or undefined if the path is invalid. + * @param appBackupPath The path to the application's backup folder. + * @returns A Promise that resolves to the name of the application in the backup folder, or undefined if the path is invalid. * @remarks This function checks for the "sku.sis" file in that path. */ GetBackupsInFolder(appBackupPath: string): Promise; /** * Retrieves cached details for a specific application. - * @param appId - The ID of the application. - * @returns {Promise} - A Promise that resolves to a stringified object. + * @param appId The ID of the application. + * @returns A Promise that resolves to a stringified object. */ GetCachedAppDetails(appId: number): Promise; // todo: Parsing nightmare @@ -170,24 +159,24 @@ export interface Apps { /** * Retrieves details for a specific screenshot upload. - * @param {string} appId - The ID of the application. - * @param {number} hHandle - The handle of the screenshot upload. - * @returns {Promise} - A Promise that resolves to details about the screenshot upload. + * @param appId The ID of the application. + * @param hHandle The handle of the screenshot upload. + * @returns A Promise that resolves to details about the screenshot upload. */ GetDetailsForScreenshotUpload(appId: string, hHandle: number): Promise; /** * Retrieves details for multiple screenshot uploads. - * @param {string} appId - The ID of the application. - * @param {number[]} hHandles - An array of handles of the screenshot uploads. - * @returns {Promise} - A Promise that resolves to details about the screenshot uploads. + * @param appId The ID of the application. + * @param hHandles An array of handles of the screenshot uploads. + * @returns A Promise that resolves to details about the screenshot uploads. */ GetDetailsForScreenshotUploads(appId: string, hHandles: number[]): Promise; /** * Retrieves a list of downloaded workshop items for a specific application. - * @param {number} appId - The ID of the application to retrieve downloaded workshop items for. - * @returns {Promise} - A Promise that resolves to an array of downloaded workshop items for the specified application. + * @param appId The ID of the application to retrieve downloaded workshop items for. + * @returns A Promise that resolves to an array of downloaded workshop items for the specified application. */ GetDownloadedWorkshopItems(appId: number): Promise; @@ -195,26 +184,25 @@ export interface Apps { /** * Retrieves achievement information for a specific application for a given friend. - * @param {string} appId - The ID of the application to retrieve achievement information for. - * @param {string} friendSteam64Id - The Steam64 ID of the friend for whom to retrieve achievement information. - * @returns {Promise} - A Promise that resolves to an object containing achievement information for the specified friend and application. + * @param appId The ID of the application to retrieve achievement information for. + * @param friendSteam64Id The Steam64 ID of the friend for whom to retrieve achievement information. + * @returns A Promise that resolves to an object containing achievement information for the specified friend and application. */ GetFriendAchievementsForApp(appId: string, friendSteam64Id: string): Promise; /** * Retrieves a list of friends who play the specified application. - * @param {number} appId - The ID of the application. - * @returns {Promise} A Promise that resolves to an array of Steam64 IDs representing friends who play the application. + * @param appId The ID of the application. + * @returns A Promise that resolves to an array of Steam64 IDs representing friends who play the application. */ GetFriendsWhoPlay(appId: number): Promise; /** * Retrieves details of a game action. - * @param {number} appId - The ID of the application. - * @param {Function} callback - The callback function to handle the retrieved game action details and state. - * @param {GameAction} callback.gameAction - The game action received in the callback. - * @param {state} callback.state - The state manager received in the callback. - * @returns {void} + * @param appId The ID of the application. + * @param callback The callback function to handle the retrieved game action details and state. + * @param callback.gameAction The game action received in the callback. + * @param callback.state The state manager received in the callback. */ GetGameActionDetails(appId: number, callback: (gameAction: GameAction) => void): void; @@ -234,27 +222,27 @@ export interface Apps { * Retrieves launch options for a specified application. * These options may include different configurations or settings for launching the application, such as DirectX, Vulkan, OpenGL, 32-bit, 64-bit, etc. * This function does not retrieve launch/argument options inputted by the user. - * @param {number} appId - The ID of the application. - * @returns {Promise} - A Promise that resolves to an array of launch options for the specified application. + * @param appId The ID of the application. + * @returns A Promise that resolves to an array of launch options for the specified application. */ GetLaunchOptionsForApp(appId: number): Promise; /** - * @returns {Promise} A Promise that resolves to a ProtoBuf message. If deserialized, returns {@link LibraryBootstrapData}. + * @returns A Promise that resolves to a ProtoBuf message. If deserialized, returns {@link LibraryBootstrapData}. */ GetLibraryBootstrapData(): Promise; /** * Retrieves achievement information for the authenticated user in a specific Steam application. - * @param {string} appId - The ID of the application to retrieve achievement information for. - * @returns {Promise} A Promise that resolves to an AppAchievementResponse object containing the achievement information for the authenticated user in the specified application. + * @param appId The ID of the application to retrieve achievement information for. + * @returns A Promise that resolves to an AppAchievementResponse object containing the achievement information for the authenticated user in the specified application. */ GetMyAchievementsForApp(appId: string): Promise; /** * Retrieves the playtime information for a specific application. - * @param {number} appId - The ID of the application to get playtime information for. - * @returns {Promise} A Promise that resolves to playtime information or undefined if not available. + * @param appId The ID of the application to get playtime information for. + * @returns A Promise that resolves to playtime information or undefined if not available. */ GetPlaytime(appId: number): Promise; @@ -262,47 +250,47 @@ export interface Apps { /** * Retrieves the resolution override for a specific application. - * @param {number} appId - The ID of the application to retrieve the resolution override for. - * @returns {Promise} A Promise that resolves to a string of the resolution override. + * @param appId The ID of the application to retrieve the resolution override for. + * @returns A Promise that resolves to a string of the resolution override. */ GetResolutionOverrideForApp(appId: number): Promise; /** * Represents a function to retrieve detailed information about a specific screenshot. - * @param {string} appId - The ID of the application the screenshot belongs to. - * @param {number} hHandle - The handle of the screenshot. - * @returns {Promise} - A Promise that resolves to detailed information about the specified screenshot. + * @param appId The ID of the application the screenshot belongs to. + * @param hHandle The handle of the screenshot. + * @returns A Promise that resolves to detailed information about the specified screenshot. */ GetScreenshotInfo(appId: string, hHandle: number): Promise; /** * Represents a function to retrieve screenshots within a specified time range. - * @param {number} appId - The ID of the application. - * @param {number} start - The start of the time range as a Unix timestamp. - * @param {number} end - The end of the time range as a Unix timestamp. - * @returns {Promise} - A Promise that resolves to an array of screenshots taken within the specified time range. + * @param appId The ID of the application. + * @param start The start of the time range as a Unix timestamp. + * @param end The end of the time range as a Unix timestamp. + * @returns A Promise that resolves to an array of screenshots taken within the specified time range. */ GetScreenshotsInTimeRange(appId: number, start: number, end: number): Promise; /** * Represents a function to retrieve shortcut data for a list of non-Steam app IDs. - * @param {number[]} appIds - An array of non-Steam application IDs. - * @returns {Promise} - A Promise that resolves to an array of Shortcut objects for the specified non-Steam app IDs. + * @param appIds An array of non-Steam application IDs. + * @returns A Promise that resolves to an array of Shortcut objects for the specified non-Steam app IDs. */ GetShortcutData(appIds: number[]): Promise; /** * Retrieves shortcut data for a given shortcut file path. - * @param {string} pathToShortcut The path to the shortcut file. - * @returns {Promise} A Promise that resolves to the shortcut data. + * @param pathToShortcut The path to the shortcut file. + * @returns A Promise that resolves to the shortcut data. */ GetShortcutDataForPath(pathToShortcut: string): Promise; /** * Represents a function to retrieve details about a soundtrack associated with a soundtrack application. * The soundtrack has to be installed. - * @param {number} appId - The ID of the soundtrack application. - * @returns {Promise} - A Promise that resolves to the details of the soundtrack associated with the specified soundtrack application. + * @param appId The ID of the soundtrack application. + * @returns A Promise that resolves to the details of the soundtrack associated with the specified soundtrack application. */ GetSoundtrackDetails(appId: number): Promise; @@ -311,17 +299,17 @@ export interface Apps { /** * Retrieves a list of subscribed workshop item details for a specific application. - * @param {number} appId - The ID of the application to retrieve subscribed workshop item details for. - * @param {string[]} itemIds - Workshop item IDs to retrieve details for. - * @returns {Promise} - A Promise that resolves to an array of subscribed workshop item details for the specified application. + * @param appId The ID of the application to retrieve subscribed workshop item details for. + * @param itemIds Workshop item IDs to retrieve details for. + * @returns A Promise that resolves to an array of subscribed workshop item details for the specified application. * @throws Throws if the query failed. */ GetSubscribedWorkshopItemDetails(appId: number, itemIds: string[]): Promise; /** * Retrieves a list of subscribed workshop items for a specific application. - * @param {number} appId - The ID of the application to retrieve subscribed workshop items for. - * @returns {Promise} - A Promise that resolves to an array of subscribed workshop items for the specified application. + * @param appId The ID of the application to retrieve subscribed workshop items for. + * @returns A Promise that resolves to an array of subscribed workshop items for the specified application. */ GetSubscribedWorkshopItems(appId: number): Promise; @@ -342,26 +330,24 @@ export interface Apps { /** * Move specified workshop item load order. - * @param appId - The ID of the application. - * @param oldOrder - The item to move, referenced by its position number. - * @param newOrder - The position number to move the item to. - * @returns {void} + * @param appId The ID of the application. + * @param oldOrder The item to move, referenced by its position number. + * @param newOrder The position number to move the item to. * @remarks Orders are zero-indexed. */ MoveWorkshopItemLoadOrder(appId: number, oldOrder: number, newOrder: number): void; /** * Opens the settings dialog for a specific application. - * @param {number} appId - The ID of the application for which to open the settings dialog. - * @param {string} section - The section (tab) to switch to. - * @returns {void} + * @param appId The ID of the application for which to open the settings dialog. + * @param section The section (tab) to switch to. */ OpenAppSettingsDialog(appId: number, section: string): void; /** * Raises the window for a given application. - * @param {string} appId - The ID of the application to raise the window of. - * @returns {Promise} - A Promise that resolves to a number. + * @param appId The ID of the application to raise the window of. + * @returns A Promise that resolves to a number. * @todo Returns a result enum? 1 if ok, 2 if not running */ RaiseWindowForGame(appId: number): Promise; // ResumeGameInProgress @@ -382,19 +368,19 @@ export interface Apps { /** * Registers a callback function to be called when achievement changes occur. * @param callback The callback function to be called. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @returns An object that can be used to unregister the callback. */ - RegisterForAchievementChanges(callback: (data: ArrayBuffer) => void): Unregisterable | any; + RegisterForAchievementChanges(callback: (data: ArrayBuffer) => void): Unregisterable; - RegisterForAppBackupStatus(callback: (appBackupStatus: AppBackupStatus) => void): Unregisterable | any; + RegisterForAppBackupStatus(callback: (appBackupStatus: AppBackupStatus) => void): Unregisterable; /** * Registers a callback function to be called when app details change. * @param appId The ID of the application to monitor. * @param callback The callback function to be called. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @returns An object that can be used to unregister the callback. */ - RegisterForAppDetails(appId: number, callback: (appDetails: AppDetails) => void): Unregisterable | any; + RegisterForAppDetails(appId: number, callback: (appDetails: AppDetails) => void): Unregisterable; /* @@ -413,38 +399,38 @@ export interface Apps { RegisterForDRMFailureResponse( callback: (appid: number, eResult: number, errorCode: number) => void, - ): Unregisterable | any; + ): Unregisterable; /** * Registers a callback function to be called when a game action ends. - * @param {function} callback - The callback function to be called. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @param callback The callback function to be called. + * @returns An object that can be used to unregister the callback. */ - RegisterForGameActionEnd(callback: (gameActionIdentifier: number) => void): Unregisterable | any; + RegisterForGameActionEnd(callback: (gameActionIdentifier: number) => void): Unregisterable; // "error" is a localization token - RegisterForGameActionShowError(callback: (gameActionId: number, appId: string, actionName: string, error: string, param4: string) => void): Unregisterable | any; + RegisterForGameActionShowError(callback: (gameActionId: number, appId: string, actionName: string, error: string, param4: string) => void): Unregisterable; /** * Registers a callback function to be called when a game action UI is shown. * @param callback The callback function to be called. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @returns An object that can be used to unregister the callback. */ - RegisterForGameActionShowUI(callback: () => void): Unregisterable | any; // todo: no idea what this callback is from + RegisterForGameActionShowUI(callback: () => void): Unregisterable; // todo: no idea what this callback is from /** * Registers a callback function to be called when a game action starts. - * @param {function} callback - The callback function to be called. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @param callback The callback function to be called. + * @returns An object that can be used to unregister the callback. */ RegisterForGameActionStart( callback: (gameActionIdentifier: number, appId: string, action: string, param3: AppLaunchSource) => void, - ): Unregisterable | any; + ): Unregisterable; /** * Registers a callback function to be called when a game action task changes. - * @param {function} callback - The callback function to be called. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @param callback The callback function to be called. + * @returns An object that can be used to unregister the callback. */ RegisterForGameActionTaskChange( callback: ( @@ -454,12 +440,12 @@ export interface Apps { requestedAction: string, param4: string, ) => void, - ): Unregisterable | any; + ): Unregisterable; /** * Registers a callback function to be called when a user requests a game action. - * @param {function} callback - The callback function to be called. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @param callback The callback function to be called. + * @returns An object that can be used to unregister the callback. */ RegisterForGameActionUserRequest( callback: ( @@ -469,43 +455,41 @@ export interface Apps { requestedAction: string, appId2: string, ) => void, - ): Unregisterable | any; + ): Unregisterable; /** * @todo returns undefined (now)? * @todo does not exist on Steam Version: 1718064497 */ - RegisterForLocalizationChanges(callback: (data: ArrayBuffer) => void): Unregisterable | any; + RegisterForLocalizationChanges(callback: (data: ArrayBuffer) => void): Unregisterable; - RegisterForPrePurchasedAppChanges(callback: () => void): Unregisterable | any; // Unknown, did have it show up a few times, but not callback parameters - RegisterForShowMarketingMessageDialog: Unregisterable | any; + RegisterForPrePurchasedAppChanges(callback: () => void): Unregisterable; // Unknown, did have it show up a few times, but not callback parameters + RegisterForShowMarketingMessageDialog: Unregisterable; /** * Registers a callback function to be notified when workshop items are added or removed from a Steam application. - * @param {function} callback - The callback function to be called. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @param callback The callback function to be called. + * @returns An object that can be used to unregister the callback. */ - RegisterForWorkshopChanges(callback: (appId: number) => void): Unregisterable | any; + RegisterForWorkshopChanges(callback: (appId: number) => void): Unregisterable; RegisterForWorkshopItemDownloads( appId: number, callback: (appId: number, publishedFileId: string, param2: number) => void, - ): Unregisterable | any; + ): Unregisterable; RegisterForWorkshopItemInstalled: any; /** * Removes a non-Steam application shortcut from the Steam library. - * @param {number} appId - The ID of the application for which to remove the shortcut. - * @returns {void} + * @param appId The ID of the application for which to remove the shortcut. */ RemoveShortcut(appId: number): void; /** * Removes a user tag from multiple Steam applications. - * @param {number[]} appIds - An array of application IDs from which the user tag should be removed. - * @param {string} userTag - The user tag to be removed. - * @returns {void} + * @param appIds An array of application IDs from which the user tag should be removed. + * @param userTag The user tag to be removed. * @remarks This function modifies the "/userdata//7/remote/sharedconfig.vdf" file. */ RemoveUserTagFromApps(appIds: number[], userTag: string): void; @@ -524,12 +508,11 @@ export interface Apps { /** * Runs a game with specified parameters. Focuses the game if already launched. - * @param {string} appId - The ID of the application to run. - * @param {string} launchOptions - Additional launch options for the application. - * @param {number} param2 - Additional parameter (exact usage may vary). - * @param {AppLaunchSource} launchSource + * @param appId The ID of the application to run. + * @param launchOptions Additional launch options for the application. + * @param param2 Additional parameter (exact usage may vary). + * @param launchSource * @remarks `launchOptions` is appended before the ones specified in the application's settings. - * @returns {void} */ RunGame(appId: string, launchOptions: string, param2: number, launchSource: AppLaunchSource): void; @@ -545,7 +528,7 @@ export interface Apps { /** * Scans the system for installed non-Steam applications. - * @returns {Promise} A Promise that resolves to an array of NonSteamApp objects representing installed non-Steam applications. + * @returns A Promise that resolves to an array of NonSteamApp objects representing installed non-Steam applications. * @remarks This function scans the user's system for installed applications that are not part of the Steam library. It does not scan for shortcuts added to the Steam library. * * On Linux, it scans inside /usr/share/applications and $XDG_DATA_HOME/applications. @@ -554,68 +537,61 @@ export interface Apps { /** * Sets the automatic update behavior for a Steam application. - * @param {number} appId - The ID of the application to set the update behavior for. - * @param {AutoUpdateBehavior} mode - The update behavior mode to set. - * @returns {void} + * @param appId The ID of the application to set the update behavior for. + * @param mode The update behavior mode to set. * @remarks This function only works with installed Steam applications. */ SetAppAutoUpdateBehavior(appId: number, mode: AutoUpdateBehavior): void; /** * Sets the background downloads behavior for a specific Steam application. - * @param {number} appId - The ID of the application to set the background downloads behavior for. - * @param {BackgroundDownloadsBehavior} mode - The background downloads mode to set. - * @returns {void} + * @param appId The ID of the application to set the background downloads behavior for. + * @param mode The background downloads mode to set. * @remarks This function only works with installed Steam applications. */ SetAppBackgroundDownloadsBehavior(appId: number, mode: BackgroundDownloadsBehavior): void; /** * Sets the current language for a specific Steam application. - * @param {number} appId - The ID of the application to set the current language for. - * @param {string} language - The language to set, represented as a language (e.g., "english", "spanish", "tchinese", "schinese"). - * @returns {void} + * @param appId The ID of the application to set the current language for. + * @param language The language to set, represented as a language (e.g., "english", "spanish", "tchinese", "schinese"). */ SetAppCurrentLanguage(appId: number, language: string): void; /** * Sets the blocked state for apps. - * @param {number[]} appIds - An array of app IDs to set the blocked state for. - * @param {boolean} state - The state to set (true for blocked, false for unblocked). - * @returns {void} + * @param appIds An array of app IDs to set the blocked state for. + * @param state The state to set (true for blocked, false for unblocked). */ SetAppFamilyBlockedState(appIds: number[], state: boolean): void; /** * Sets the hidden status of a specific Steam application. - * @param {number} appId - The ID of the application to set the hidden status for. - * @param {boolean} value - The value indicating whether the application should be hidden (true) or not (false). - * @returns {void} + * @param appId The ID of the application to set the hidden status for. + * @param value The value indicating whether the application should be hidden (true) or not (false). * @remarks This function modifies the "/userdata//7/remote/sharedconfig.vdf" file to set the hidden status of the specified application. */ SetAppHidden(appId: number, value: boolean): void; /** * Sets launch options for a Steam application. - * @param {number} appId - The ID of the application to set launch options for. - * @param {string} launchOptions - The launch options to be set for the application. - * @returns {void} + * @param appId The ID of the application to set launch options for. + * @param launchOptions The launch options to be set for the application. */ SetAppLaunchOptions(appId: number, launchOptions: string): void; /** * Sets a resolution override for a Steam application. - * @param {number} appId - The ID of the application to set the resolution override for. - * @param {string} resolution - The resolution to be set for the application. It can be "Default", "Native", or other compatible resolutions for the user's monitor. - * @returns {void} + * @param appId The ID of the application to set the resolution override for. + * @param resolution The resolution to be set for the application. It can be "Default", "Native", or other compatible resolutions for the user's monitor. */ SetAppResolutionOverride(appId: number, resolution: string): any; /** * Sets cached details for a specific application. - * @param {number} appId - The ID of the application. - * @param {string} details - The details to be cached, a stringified object. - * @returns {Promise} - A Promise that resolves when the details are successfully cached. + * @param appId The ID of the application. + * @param details The details to be cached, a stringified object. + * @returns A Promise that resolves when the details are successfully cached. * todo: might return boolean? */ SetCachedAppDetails(appId: number, details: string): Promise; @@ -624,100 +600,93 @@ export interface Apps { /** * Sets the custom artwork for a given application. - * @param {number} appId - The ID of the application to set custom artwork for. - * @param {string} base64Image - Base64 encoded image. - * @param {string} imageType - "jpeg" or "png". - * @param {AppArtworkAssetType} assetType - The type of artwork to set. - * @returns {Promise} A Promise that resolves after the custom artwork is set. + * @param appId The ID of the application to set custom artwork for. + * @param base64Image Base64 encoded image. + * @param imageType "jpeg" or "png". + * @param assetType The type of artwork to set. + * @returns A Promise that resolves after the custom artwork is set. */ SetCustomArtworkForApp(appId: number, base64Image: string, imageType: string, assetType: AppArtworkAssetType): Promise; /** * Sets a custom logo position for a specific app. - * @param {number} appId - The ID of the application. - * @param {string} details - The details of the custom logo position, expected to be a stringified {@link LogoPositionForApp} object. - * @returns {Promise} - A Promise that resolves when the custom logo position is successfully set. + * @param appId The ID of the application. + * @param details The details of the custom logo position, expected to be a stringified {@link LogoPositionForApp} object. + * @returns A Promise that resolves when the custom logo position is successfully set. */ SetCustomLogoPositionForApp(appId: number, details: string): Promise; /** * Sets the enabled state for downloadable content (DLC) of a specific app. - * @param {number} appId - The ID of the parent application. - * @param {number} appDLCId - The ID of the DLC to set the state for. - * @param {boolean} value - The value to set (true for enabled, false for disabled). - * @returns {void} + * @param appId The ID of the parent application. + * @param appDLCId The ID of the DLC to set the state for. + * @param value The value to set (true for enabled, false for disabled). */ SetDLCEnabled(appId: number, appDLCId: number, value: boolean): void; /** * Set a local screenshot's caption. - * @param {string} appId - The application ID the screenshot belongs to. - * @param {number} hHandle - The handle of the screenshot. - * @param {string} caption - * @returns {void} + * @param appId The application ID the screenshot belongs to. + * @param hHandle The handle of the screenshot. + * @param caption */ SetLocalScreenshotCaption(appId: string, hHandle: any, caption: string): void; /** * Set a local screenshot's privacy state. - * @param {string} appId - The application ID the screenshot belongs to. - * @param {number} hHandle - The handle of the screenshot. - * @param {FilePrivacyState} privacy - Screenshot privacy state. + * @param appId The application ID the screenshot belongs to. + * @param hHandle The handle of the screenshot. + * @param privacy Screenshot privacy state. */ SetLocalScreenshotPrivacy(appId: string, hHandle: any, privacy: FilePrivacyState): void; /** * Set a local screenshot's spoiler state. - * @param {string} appId - The application ID the screenshot belongs to. - * @param {number} hHandle - The handle of the screenshot. - * @param {boolean} spoilered - Is the screenshot spoilered? + * @param appId The application ID the screenshot belongs to. + * @param hHandle The handle of the screenshot. + * @param spoilered Is the screenshot spoilered? */ SetLocalScreenshotSpoiler(appId: string, hHandle: any, spoilered: boolean): void; /** * Sets the icon for a non-Steam application shortcut. - * @param {string} appId - The ID of the application to set the shortcut icon for. - * @param {string} iconPath - The path to the icon image (can be png or tga format). - * @returns {void} + * @param appId The ID of the application to set the shortcut icon for. + * @param iconPath The path to the icon image (can be png or tga format). */ SetShortcutIcon(appId: number, iconPath: string): void; /** * Sets whether a non-Steam application shortcut should be included in the VR library. - * @param {number} appId The ID of the application to set the VR status for. - * @param {boolean} value A boolean indicating whether the application should be included in the VR library. - * @returns {void} + * @param appId The ID of the application to set the VR status for. + * @param value A boolean indicating whether the application should be included in the VR library. */ SetShortcutIsVR(appId: number, value: boolean): void; /** * Sets launch options for a non-Steam application shortcut. - * @param {number} appId - The ID of the application to set the launch options for. - * @param {string} launchOptions - The launch options to be used when starting the application. - * @returns {void} + * @param appId The ID of the application to set the launch options for. + * @param launchOptions The launch options to be used when starting the application. */ SetShortcutLaunchOptions(appId: number, launchOptions: string): void; /** * Sets the name for a non-Steam application shortcut. - * @param {number} appId - The ID of the application to set the shortcut name for. - * @param {string} shortcutName - The name to be displayed for the application shortcut. - * @returns {void} + * @param appId The ID of the application to set the shortcut name for. + * @param shortcutName The name to be displayed for the application shortcut. */ SetShortcutName(appId: number, shortcutName: string): void; /** * Sets the starting directory for a non-Steam application shortcut. - * @param {number} appId - The ID of the application to set the starting directory for. - * @param {string} directory - The directory from which the application should be launched. - * @returns {void} + * @param appId The ID of the application to set the starting directory for. + * @param directory The directory from which the application should be launched. */ SetShortcutStartDir(appId: number, directory: string): void; /** * Sets the client ID for streaming for a specific application. - * @param {number} appId - The ID of the application. - * @param {string} clientId - The client ID for streaming. + * @param appId The ID of the application. + * @param clientId The client ID for streaming. */ SetStreamingClientForApp(appId: number, clientId: string): void; @@ -725,33 +694,29 @@ export interface Apps { /** * Sets the workshop items disabled state. - * @param {number} appId - The ID of the application. - * @param {string[]} itemIds - Workshop item IDs to change the state for. - * @param {boolean} value - `true` to disable, `false` otherwise. - * @returns {void} + * @param appId The ID of the application. + * @param itemIds Workshop item IDs to change the state for. + * @param value `true` to disable, `false` otherwise. */ SetWorkshopItemsDisabledLocally(appId: number, itemIds: string[], value: boolean): void; /** * Sets the workshop items load order for a specified application. - * @param {number} appId - The ID of the application. - * @param {string[]} itemIds - Workshop item IDs. - * @returns {void} + * @param appId The ID of the application. + * @param itemIds Workshop item IDs. * @remarks `itemIds` has to be the full list of subscribed items, otherwise the specified items get moved to the last position. */ SetWorkshopItemsLoadOrder(appId: number, itemIds: string[]): void; /** * Opens the controller configurator for a specific application. - * @param {number} appId - The ID of the application for which to open the controller configurator. - * @returns {void} + * @param appId The ID of the application for which to open the controller configurator. */ ShowControllerConfigurator(appId: number): void; /** * Opens the Steam store page for a specific application. - * @param {number} appId - The ID of the application. - * @returns {void} + * @param appId The ID of the application. */ ShowStore(appId: number): void; @@ -759,9 +724,8 @@ export interface Apps { /** * Specifies a compatibility tool by its name for a given application. If strToolName is an empty string, the specified application will no longer use a compatibility tool. - * @param {number} appId - The ID of the application to specify compatibility tool for. - * @param {string} strToolName - The name of the compatibility tool to specify. - * @returns {void} + * @param appId The ID of the application to specify compatibility tool for. + * @param strToolName The name of the compatibility tool to specify. */ SpecifyCompatTool(appId: number, strToolName: string): void; @@ -769,18 +733,16 @@ export interface Apps { /** * Subscribes or unsubscribes from a workshop item for a specific app. - * @param {number} appId - The ID of the application. - * @param {string} workshopId - The ID of the workshop item. - * @param {boolean} subscribed - True to subscribe, false to unsubscribe. - * @returns {void} + * @param appId The ID of the application. + * @param workshopId The ID of the workshop item. + * @param subscribed True to subscribe, false to unsubscribe. */ SubscribeWorkshopItem(appId: number, workshopId: string, subscribed: boolean): void; /** * Terminates a running application. - * @param {string} appId - The ID of the application to terminate. - * @param {boolean} param1 - Additional parameter. Exact usage may vary. - * @returns {void} + * @param appId The ID of the application to terminate. + * @param param1 Additional parameter. Exact usage may vary. */ TerminateApp(appId: string, param1: boolean): void; @@ -789,8 +751,7 @@ export interface Apps { /** * Toggles the Steam Cloud synchronization for game saves for a specific application. - * @param {number} appId - The ID of the application. - * @returns {void} + * @param appId The ID of the application. * @remarks This function modifies the "/userdata//7/remote/sharedconfig.vdf" file. */ ToggleAppSteamCloudEnabled(appId: number): void; @@ -800,8 +761,7 @@ export interface Apps { /** * Toggles the Steam Overlay setting for a specific application. - * @param {number} appId - The ID of the application. - * @returns {void} + * @param appId The ID of the application. */ ToggleEnableSteamOverlayForApp(appId: number): void; @@ -812,7 +772,7 @@ export interface Apps { /** * Verifies the integrity of an app's files. - * @param {number} appId - The ID of the app to verify. + * @param appId The ID of the app to verify. */ VerifyApp(appId: number): Promise; // todo: returns {"nGameActionID":9} } @@ -1727,4 +1687,4 @@ export enum AppCloudStatus { SyncFailed = 8, Conflict = 9, PendingElsewhere = 10, -} \ No newline at end of file +} diff --git a/src/deck-components/steam-client/Auth.ts b/src/deck-components/steam-client/Auth.ts index b965ac97..f0968728 100644 --- a/src/deck-components/steam-client/Auth.ts +++ b/src/deck-components/steam-client/Auth.ts @@ -5,7 +5,7 @@ export interface Auth { GetLocalHostname(): Promise; /** - * @returns {Promise} A Promise that resolves to a ProtoBuf message. If deserialized, returns {@link Authentication_DeviceDetails}. + * @returns A Promise that resolves to a ProtoBuf message. If deserialized, returns {@link Authentication_DeviceDetails}. */ GetMachineID(): Promise; @@ -82,4 +82,4 @@ export enum GamingDeviceType { Handheld = 512, Phone = 528, SteamDeck = 544, -} \ No newline at end of file +} diff --git a/src/deck-components/steam-client/Broadcast.ts b/src/deck-components/steam-client/Broadcast.ts index 9a32357b..642157fe 100644 --- a/src/deck-components/steam-client/Broadcast.ts +++ b/src/deck-components/steam-client/Broadcast.ts @@ -3,44 +3,43 @@ import {Result, Unregisterable} from "./index"; export interface Broadcast { /** * Approves a viewer request for the broadcast. - * @param {string} steamId64 - The SteamID64 of the user whose request is to be approved. - * @param {number} param1 - Unknown parameter. + * @param steamId64 The SteamID64 of the user whose request is to be approved. + * @param param1 Unknown parameter. */ ApproveViewerRequest(steamId64: string, param1: number): void; /** * Invites a user identified by their SteamID64 to watch the broadcast. - * @param {string} steamId64 - The SteamID64 of the user to invite. - * @returns {Promise} - A Promise indicating the result of the invitation (1 for success, 2 for error). + * @param steamId64 The SteamID64 of the user to invite. + * @returns A Promise indicating the result of the invitation (1 for success, 2 for error). */ InviteToWatch(steamId64: string): Promise; /** * Registers a callback to be called when the broadcast status changes. - * @param {function} callback - The callback function to be called. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @param callback The callback function to be called. + * @returns An object that can be used to unregister the callback. */ - RegisterForBroadcastStatus(callback: (broadcastStatus: BroadcastStatus) => void): Unregisterable | any; + RegisterForBroadcastStatus(callback: (broadcastStatus: BroadcastStatus) => void): Unregisterable; /** * Registers a callback to be called when viewer requests are received. - * @param {function} callback - The callback function to be called. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @param callback The callback function to be called. + * @returns An object that can be used to unregister the callback. */ RegisterForViewerRequests( callback: (viewerFriendCode: number, param1: number, param2: number) => void, - ): Unregisterable | any; + ): Unregisterable; /** * Rejects a viewer request for the broadcast. - * @param {string} steamId64 - The SteamID64 of the user whose request is to be rejected. - * @param {number} param1 - Unknown parameter. + * @param steamId64 The SteamID64 of the user whose request is to be rejected. + * @param param1 Unknown parameter. */ RejectViewerRequest(steamId64: string, param1: number): void; /** * Stops the broadcast. - * @returns {void} */ StopBroadcasting(): void; } @@ -57,4 +56,4 @@ export interface BroadcastStatus { bMicrophoneActive: boolean; nCurrentFPS: number; nUploadKbps: number; -} \ No newline at end of file +} diff --git a/src/deck-components/steam-client/Browser.ts b/src/deck-components/steam-client/Browser.ts index 6ed91980..6df884f7 100644 --- a/src/deck-components/steam-client/Browser.ts +++ b/src/deck-components/steam-client/Browser.ts @@ -17,7 +17,6 @@ export interface Browser { /** * Hides the mouse cursor until input. - * @returns {void} */ HideCursorUntilMouseEvent(): void; @@ -38,15 +37,14 @@ export interface Browser { /** * @todo unconfirmed */ - RegisterForGestureEvents(callback: (gesture: TouchGesture) => void): Unregisterable | any; + RegisterForGestureEvents(callback: (gesture: TouchGesture) => void): Unregisterable; - RegisterForOpenNewTab: Unregisterable | any; + RegisterForOpenNewTab: Unregisterable; ReplaceMisspelling: any; /** * Restarts the Steam JS context. - * @returns {void} */ RestartJSContext(): void; @@ -60,8 +58,7 @@ export interface Browser { /** * Prompts and downloads a file. - * @param {string} url - The URL of the file to download. - * @returns {void} + * @param url The URL of the file to download. */ StartDownload(url: string): void; } @@ -87,4 +84,4 @@ export enum TouchGestureType { PinchEnd = 11, FlingStart = 12, FlingCancelled = 13, -} \ No newline at end of file +} diff --git a/src/deck-components/steam-client/ClientNotifications.ts b/src/deck-components/steam-client/ClientNotifications.ts index 4f9d70e4..d74ce344 100644 --- a/src/deck-components/steam-client/ClientNotifications.ts +++ b/src/deck-components/steam-client/ClientNotifications.ts @@ -3,14 +3,14 @@ import { BrowserContext } from "./index"; export interface ClientNotifications { /** * Displays a Steam notification. - * @param {ClientUINotificationType} notification - Notification type. - * @param {string} options - Stringified object of {@link SteamNotificationOptions}. - * @param {function} callback + * @param notification Notification type. + * @param options Stringified object of {@link SteamNotificationOptions}. + * @param callback */ DisplayClientNotification( notification: ClientUINotificationType, options: string, - callback: (browser: BrowserContext) => void, + callback: (context: BrowserContext) => void, ): void; /** @@ -36,4 +36,4 @@ export enum ClientUINotificationType { GroupChatMessage = 1, FriendChatMessage = 2, FriendPersonaState = 3, -} \ No newline at end of file +} diff --git a/src/deck-components/steam-client/Cloud.ts b/src/deck-components/steam-client/Cloud.ts index f4141d8d..9088ab91 100644 --- a/src/deck-components/steam-client/Cloud.ts +++ b/src/deck-components/steam-client/Cloud.ts @@ -1,16 +1,16 @@ export interface Cloud { /** * Resolves a synchronization conflict for an app in the cloud. - * @param {number} appId - The ID of the app with the sync conflict. - * @param {boolean} keepLocal - Whether to keep the local version during conflict resolution. - * @returns {any} - Returns data related to resolving the sync conflict. + * @param appId The ID of the app with the sync conflict. + * @param keepLocal Whether to keep the local version during conflict resolution. + * @returns Returns data related to resolving the sync conflict. */ ResolveAppSyncConflict(appId: number, keepLocal: boolean): void; /** * Retries syncing an app with the cloud. - * @param {number} appId - The ID of the app to retry syncing. - * @returns {any} - Returns data related to retrying the app sync. + * @param appId The ID of the app to retry syncing. + * @returns Returns data related to retrying the app sync. */ RetryAppSync(appId: number): void; -} \ No newline at end of file +} diff --git a/src/deck-components/steam-client/CommunityItems.ts b/src/deck-components/steam-client/CommunityItems.ts index 8c27aee5..9f2e0945 100644 --- a/src/deck-components/steam-client/CommunityItems.ts +++ b/src/deck-components/steam-client/CommunityItems.ts @@ -21,4 +21,4 @@ export interface CommunityItems { GetItemAssetPath(communityItemId: string, param1: any, param2: string): any; RemoveDownloadedItemAsset(communityItemId: string, param1: any, param2: string): any; -} \ No newline at end of file +} diff --git a/src/deck-components/steam-client/Console.ts b/src/deck-components/steam-client/Console.ts index ff7d94bb..3edad44b 100644 --- a/src/deck-components/steam-client/Console.ts +++ b/src/deck-components/steam-client/Console.ts @@ -6,24 +6,23 @@ import {Unregisterable} from "./index"; export interface Console { /** * Executes a console command. - * @param {string} command - The command to execute in the console. - * @returns {void} + * @param command The command to execute in the console. */ ExecCommand(command: string): void; /** * Retrieves autocomplete suggestions for a given console command. - * @param {string} command - The console command to provide autocomplete suggestions for. - * @returns {Promise} - A Promise that resolves to an array of autocomplete suggestions. + * @param command The console command to provide autocomplete suggestions for. + * @returns A Promise that resolves to an array of autocomplete suggestions. */ GetAutocompleteSuggestions(command: string): Promise; /** * Registers a callback function to receive spew output. - * @param {function} callback - The callback function that will receive spew output. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @param callback The callback function that will receive spew output. + * @returns An object that can be used to unregister the callback. */ - RegisterForSpewOutput(callback: (spewOutput: SpewOutput) => void): Unregisterable | any; + RegisterForSpewOutput(callback: (spewOutput: SpewOutput) => void): Unregisterable; } /** @@ -39,4 +38,4 @@ export interface SpewOutput { * The type or category of the spew output. */ spew_type: "error" | "info" | "input"; -} \ No newline at end of file +} diff --git a/src/deck-components/steam-client/Downloads.ts b/src/deck-components/steam-client/Downloads.ts index 53dd1da7..ffbd16c6 100644 --- a/src/deck-components/steam-client/Downloads.ts +++ b/src/deck-components/steam-client/Downloads.ts @@ -7,21 +7,19 @@ import {AppError} from "./App"; export interface Downloads { /** * Enables or disables all downloads in Steam. - * @param {boolean} enable - True to enable downloads, false to disable. + * @param enable True to enable downloads, false to disable. */ EnableAllDownloads(enable: boolean): void; /** * Moves the update for a specific app down the download queue. - * @param {number} appId - The ID of the application to move. - * @returns {void} + * @param appId The ID of the application to move. */ MoveAppUpdateDown(appId: number): void; /** * Moves the update for a specific app up the download queue. - * @param {number} appId - The ID of the application to move. - * @returns {void} + * @param appId The ID of the application to move. */ MoveAppUpdateUp(appId: number): void; @@ -29,68 +27,61 @@ export interface Downloads { /** * Adds the update for a specific app to the download queue. - * @param {number} appId - The ID of the application to queue. - * @returns {void} + * @param appId The ID of the application to queue. */ QueueAppUpdate(appId: number): void; /** * Registers a callback function to be called when download items change. - * @param {function} callback - The callback function to be called. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @param callback The callback function to be called. + * @returns An object that can be used to unregister the callback. */ RegisterForDownloadItems( callback: (isDownloading: boolean, downloadItems: DownloadItem[]) => void, - ): Unregisterable | any; + ): Unregisterable; /** * Registers a callback function to be called when download overview changes. - * @param {function} callback - The callback function to be called. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @param callback The callback function to be called. + * @returns An object that can be used to unregister the callback. */ - RegisterForDownloadOverview(callback: (downloadOverview: DownloadOverview) => void): Unregisterable | any; + RegisterForDownloadOverview(callback: (downloadOverview: DownloadOverview) => void): Unregisterable; /** * Removes the update for a specific app from the download list and places it in the unscheduled list. - * @param {number} appId - The ID of the application to remove. - * @returns {void} + * @param appId The ID of the application to remove. */ RemoveFromDownloadList(appId: number): void; /** * Resumes the update for a specific app in the queue. - * @param {number} appId - The ID of the application to resume. - * @returns {void} + * @param appId The ID of the application to resume. */ ResumeAppUpdate(appId: number): void; /** * Sets an app to launch when its download is complete. - * @param {number} appId - The ID of the application to set. - * @returns {void} + * @param appId The ID of the application to set. */ SetLaunchOnUpdateComplete(appId: number): void; /** * Sets the queue index for an app in the download queue. - * @param {number} appId - The ID of the application to set the index for. - * @param {number} index - The index to set. - * @returns {void} + * @param appId The ID of the application to set the index for. + * @param index The index to set. * @remarks Index of 0 is the current download in progress. */ SetQueueIndex(appId: number, index: number): void; /** * Suspends or resumes download throttling. - * @param {boolean} suspend - Whether to suspend or resume download throttling. - * @returns {void} + * @param suspend Whether to suspend or resume download throttling. */ SuspendDownloadThrottling(suspend: boolean): void; /** * Suspends or resumes local transfers. - * @param {boolean} suspend - Whether to suspend or resume local transfers. - * @returns {void} + * @param suspend Whether to suspend or resume local transfers. */ SuspendLanPeerContent(suspend: boolean): void; } diff --git a/src/deck-components/steam-client/FamilySharing.ts b/src/deck-components/steam-client/FamilySharing.ts index 8b3265bc..9b45f235 100644 --- a/src/deck-components/steam-client/FamilySharing.ts +++ b/src/deck-components/steam-client/FamilySharing.ts @@ -4,7 +4,7 @@ export interface FamilySharing { /** * Authorizes library sharing on the local device. - * @returns {Promise} A Promise that resolves to a status code. + * @returns A Promise that resolves to a status code. * FamilySettings_SteamGuardRequired - 18 * FamilySettings_LimitExceeded - 25 * FamilySettings_FailedToAuthorize - any other number @@ -13,7 +13,7 @@ export interface FamilySharing { /** * Deauthorizes library sharing on the local device. - * @returns {Promise} A Promise that resolves to a status code. + * @returns A Promise that resolves to a status code. */ DeauthorizeLocalDevice(): Promise; @@ -41,4 +41,4 @@ export interface Lender { numDlc: number; bPreferred: boolean; vecDLC: any[]; -} \ No newline at end of file +} diff --git a/src/deck-components/steam-client/FriendSettings.ts b/src/deck-components/steam-client/FriendSettings.ts index 746986b0..d60055fd 100644 --- a/src/deck-components/steam-client/FriendSettings.ts +++ b/src/deck-components/steam-client/FriendSettings.ts @@ -6,17 +6,17 @@ import {Unregisterable} from "./index"; export interface FriendSettings { /** * Retrieves a list of enabled friend settings features. - * @returns {Promise} - A Promise that resolves to an array of enabled friend settings features. + * @returns A Promise that resolves to an array of enabled friend settings features. */ GetEnabledFeatures(): Promise; /** * Registers a callback function to be notified of friend settings changes. - * @param callback - The callback function to be called when friend settings change. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @param callback The callback function to be called when friend settings change. + * @returns An object that can be used to unregister the callback. * @remarks The callback receives an escaped JSON object string as "settingsChanges", which should be parsed into {@link FriendSettingsChange} object. */ - RegisterForSettingsChanges(callback: (settingsChanges: string) => void): Unregisterable | any; + RegisterForSettingsChanges(callback: (settingsChanges: string) => void): Unregisterable; SetFriendSettings(details: string): any; // stringified object } @@ -66,4 +66,4 @@ export interface FriendSettingsChange { bDisableRoomEffects: number; bAnimatedAvatars: number; featuresEnabled: FriendSettingsEnabledFeature; -} \ No newline at end of file +} diff --git a/src/deck-components/steam-client/Friends.ts b/src/deck-components/steam-client/Friends.ts index e01330d0..18e75b26 100644 --- a/src/deck-components/steam-client/Friends.ts +++ b/src/deck-components/steam-client/Friends.ts @@ -6,8 +6,8 @@ import { Unregisterable } from "./index"; export interface Friends { /** * Adds a user to the friend list. - * @param {string} steamId - The Steam ID of the user to add as a friend. - * @returns {Promise} A Promise that resolves to true if the friend was added successfully, false otherwise. + * @param steamId The Steam ID of the user to add as a friend. + * @returns A Promise that resolves to true if the friend was added successfully, false otherwise. */ AddFriend(steamId: string): Promise; @@ -21,10 +21,10 @@ export interface Friends { /** * Invites a user to a specific game. - * @param {string} steamId - The Steam ID of the user to invite. - * @param {number} appId - The ID of the game to invite the user to. - * @param {string} connectString - Additional parameters for the invitation. - * @returns {Promise} A Promise that resolves to true if the user was invited successfully, false otherwise. + * @param steamId The Steam ID of the user to invite. + * @param appId The ID of the game to invite the user to. + * @param connectString Additional parameters for the invitation. + * @returns A Promise that resolves to true if the user was invited successfully, false otherwise. */ InviteUserToGame(steamId: string, appId: number, connectString: string): Promise; @@ -34,12 +34,12 @@ export interface Friends { //(e.ConvertTo64BitString()) InviteUserToRemotePlayTogetherCurrentGame(steam64Id: string): any; - RegisterForVoiceChatStatus(callback: (status: VoiceChatStatus) => void): Unregisterable | any; + RegisterForVoiceChatStatus(callback: (status: VoiceChatStatus) => void): Unregisterable; /** * Removes a user from the friend list. - * @param {string} steamId - The Steam ID of the user to remove from the friend list. - * @returns {Promise} A Promise that resolves to true if the friend was removed successfully, false otherwise. + * @param steamId The Steam ID of the user to remove from the friend list. + * @returns A Promise that resolves to true if the friend was removed successfully, false otherwise. */ RemoveFriend(steamId: string): Promise; } @@ -59,4 +59,4 @@ export interface VoiceChatStatus { bVoiceChatActive: boolean; bMicMuted: boolean; bOutputMuted: boolean; -} \ No newline at end of file +} diff --git a/src/deck-components/steam-client/GameNotes.ts b/src/deck-components/steam-client/GameNotes.ts index e9820aa1..5c349e38 100644 --- a/src/deck-components/steam-client/GameNotes.ts +++ b/src/deck-components/steam-client/GameNotes.ts @@ -27,4 +27,4 @@ export interface GameNotes { SyncToServer(): Promise; UploadImage: any; -} \ No newline at end of file +} diff --git a/src/deck-components/steam-client/GameSessions.ts b/src/deck-components/steam-client/GameSessions.ts index 5d41a1a4..a3d28615 100644 --- a/src/deck-components/steam-client/GameSessions.ts +++ b/src/deck-components/steam-client/GameSessions.ts @@ -8,30 +8,30 @@ import { Screenshot } from "./Screenshots"; export interface GameSessions { /** * Registers a callback function to be called when an achievement notification is received. - * @param {function} callback - The callback function to be called. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @param callback The callback function to be called. + * @returns An object that can be used to unregister the callback. */ RegisterForAchievementNotification( callback: (achievementNotification: AchievementNotification) => void, - ): Unregisterable | any; + ): Unregisterable; /** * Registers a callback function to be called when an app lifetime notification is received. - * @param {function} callback - The callback function to be called. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @param callback The callback function to be called. + * @returns An object that can be used to unregister the callback. */ RegisterForAppLifetimeNotifications( callback: (appLifetimeNotification: AppLifetimeNotification) => void, - ): Unregisterable | any; + ): Unregisterable; /** * Registers a callback function to be called when a screenshot notification is received. - * @param {function} callback - The callback function to be called. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @param callback The callback function to be called. + * @returns An object that can be used to unregister the callback. */ RegisterForScreenshotNotification( callback: (screenshotNotification: ScreenshotNotification) => void, - ): Unregisterable | any; + ): Unregisterable; } export interface AchievementNotification { @@ -55,4 +55,4 @@ export interface ScreenshotNotification { hScreenshot: number; strOperation: "deleted" | "written"; unAppID: number; -} \ No newline at end of file +} diff --git a/src/deck-components/steam-client/Input.ts b/src/deck-components/steam-client/Input.ts index ecc3835a..90bf784e 100644 --- a/src/deck-components/steam-client/Input.ts +++ b/src/deck-components/steam-client/Input.ts @@ -18,16 +18,14 @@ export interface Input { /** * Writes text. - * @param {string} textToWrite - The text to write. - * @returns {void} + * @param textToWrite The text to write. */ ControllerKeyboardSendText(textToWrite: string): void; /** * Sets a specified key's pressed state. - * @param {HIDKeyboardKey} keyIndex - The key index to set the state for. - * @param {boolean} state - true for pressed, false otherwise. - * @returns {void} + * @param keyIndex The key index to set the state for. + * @param state true for pressed, false otherwise. * @example * Send paste command: * ``` @@ -62,8 +60,8 @@ export interface Input { /** * Retrieves the controller mapping string for the specified controller index. - * @param {number} unControllerIndex - The controller index. - * @returns {Promise} - A Promise that resolves to the controller mapping string. + * @param unControllerIndex The controller index. + * @returns A Promise that resolves to the controller mapping string. */ GetControllerMappingString(unControllerIndex: number): Promise; @@ -90,75 +88,75 @@ export interface Input { QueryControllerConfigsForApp(appId: number, controllerIndex: number, param2: boolean): any; - RegisterForActiveControllerChanges: Unregisterable | any; // {"nActiveController":0} + RegisterForActiveControllerChanges: Unregisterable; // {"nActiveController":0} //param0 - e possibly appid? //param1 - some index? - RegisterForConfigSelectionChanges(callback: (param0: number, param1: number) => void): Unregisterable | any; + RegisterForConfigSelectionChanges(callback: (param0: number, param1: number) => void): Unregisterable; - RegisterForControllerAccountChanges: Unregisterable | any; + RegisterForControllerAccountChanges: Unregisterable; RegisterForControllerAnalogInputMessages( callback: (controllerAnalogInputMessages: ControllerAnalogInputMessage[]) => void, - ): Unregisterable | any; + ): Unregisterable; RegisterForControllerCommandMessages( callback: (controllerCommandMessage: ControllerCommandMessage) => void, - ): Unregisterable | any; + ): Unregisterable; /** * Registers a callback for changes in controller configuration cloud state. - * @param {(controllerConfigCloudStateChange: ControllerConfigCloudStateChange) => void} callback - The callback function for config cloud state changes. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @param callback The callback function for config cloud state changes. + * @returns An object that can be used to unregister the callback. */ RegisterForControllerConfigCloudStateChanges( callback: (controllerConfigCloudStateChange: ControllerConfigCloudStateChange) => void, - ): Unregisterable | any; + ): Unregisterable; /** * Registers a callback for receiving controller configuration info messages (controller layouts query, personal controller layout query). - * @param {(controllerConfigInfoMessages: ControllerConfigInfoMessageList[] | ControllerConfigInfoMessageQuery[]) => void} callback - The callback function for controller config info messages. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @param callback The callback function for controller config info messages. + * @returns An object that can be used to unregister the callback. * @remarks Do Not Use, this will break the controller layout selection unless you know what you are doing. */ RegisterForControllerConfigInfoMessages( callback: ( controllerConfigInfoMessages: ControllerConfigInfoMessageList[] | ControllerConfigInfoMessageQuery[], ) => void, - ): Unregisterable | any; + ): Unregisterable; /** * Registers a callback function to be invoked when controller input messages are received. - * @param {(controllerInputMessages: ControllerInputMessage[]) => void} callback - The callback function to be invoked when controller input messages are received. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @param callback The callback function to be invoked when controller input messages are received. + * @returns An object that can be used to unregister the callback. */ RegisterForControllerInputMessages( callback: (controllerInputMessages: ControllerInputMessage[]) => void, - ): Unregisterable | any; + ): Unregisterable; - RegisterForControllerListChanges(callback: (controllerListChanges: ControllerInfo[]) => void): Unregisterable | any; + RegisterForControllerListChanges(callback: (controllerListChanges: ControllerInfo[]) => void): Unregisterable; /** * Registers a callback for changes in the controller state (buttons presses, triggers presses, joystick changes etc...). - * @param {(controllerStateChanges: ControllerStateChange[]) => void} callback - The callback function for controller state changes. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @param callback The callback function for controller state changes. + * @returns An object that can be used to unregister the callback. */ RegisterForControllerStateChanges( callback: (controllerStateChanges: ControllerStateChange[]) => void, - ): Unregisterable | any; + ): Unregisterable; - RegisterForDualSenseUpdateNotification(callback: (m_strDualSenseUpdateProduct: string) => void): Unregisterable | any; + RegisterForDualSenseUpdateNotification(callback: (m_strDualSenseUpdateProduct: string) => void): Unregisterable; /** * Registers a callback for receiving game keyboard messages (text field popup for inputting text for games when in character creation or etc...). - * @param {(gameKeyboardMessage: GameKeyboardMessage) => void} callback - The callback function for game keyboard messages. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @param callback The callback function for game keyboard messages. + * @returns An object that can be used to unregister the callback. */ - RegisterForGameKeyboardMessages(callback: (gameKeyboardMessage: GameKeyboardMessage) => void): Unregisterable | any; + RegisterForGameKeyboardMessages(callback: (gameKeyboardMessage: GameKeyboardMessage) => void): Unregisterable; - RegisterForRemotePlayConfigChanges(callback: () => void): Unregisterable | any; + RegisterForRemotePlayConfigChanges(callback: () => void): Unregisterable; //data.appId, data.ulConfigId - RegisterForShowControllerLayoutPreviewMessages(callback: (data: any) => void): Unregisterable | any; + RegisterForShowControllerLayoutPreviewMessages(callback: (data: any) => void): Unregisterable; /* onTouchMenuInput(e) { @@ -168,23 +166,23 @@ export interface Input { } } */ - RegisterForTouchMenuInputMessages(callback: (inputs: number[]) => void): Unregisterable | any; + RegisterForTouchMenuInputMessages(callback: (inputs: number[]) => void): Unregisterable; - RegisterForTouchMenuMessages(callback: (touchMenuMessage: TouchMenuMessage) => void): Unregisterable | any; + RegisterForTouchMenuMessages(callback: (touchMenuMessage: TouchMenuMessage) => void): Unregisterable; //param0 - index? - RegisterForUIVisualization(param0: any, param1: any, param2: any): Unregisterable | any; + RegisterForUIVisualization(param0: any, param1: any, param2: any): Unregisterable; - RegisterForUnboundControllerListChanges(callback: (m_unboundControllerList: any) => void): Unregisterable | any; // param0 is an array + RegisterForUnboundControllerListChanges(callback: (m_unboundControllerList: any) => void): Unregisterable; // param0 is an array /* OnDismissKeyboardMessage(e) { this.m_WindowStore.SteamUIWindows.forEach((e => e.VirtualKeyboardManager.SetVirtualKeyboardHidden(e.BrowserWindow))) } */ - RegisterForUserDismissKeyboardMessages(callback: (param0: any) => void): Unregisterable | any; + RegisterForUserDismissKeyboardMessages(callback: (param0: any) => void): Unregisterable; - RegisterForUserKeyboardMessages: Unregisterable | any; + RegisterForUserKeyboardMessages: Unregisterable; RequestGyroActive(controllerIndex: number, param1: boolean): any; @@ -301,10 +299,9 @@ export interface Input { /** * Sets the mouse position. - * @param {number} pid - 0 - * @param {number} x - Mouse X position. - * @param {number} y - Mouse Y position. - * @returns {void} + * @param pid 0 + * @param x Mouse X position. + * @param y Mouse Y position. */ SetMousePosition(pid: number, x: number, y: number): void; @@ -320,7 +317,6 @@ export interface Input { /** * Opens the Steam Input controller settings. * This function displays the Steam Input controller settings for configuration. - * @returns {void} */ ShowControllerSettings(): void; @@ -744,4 +740,4 @@ export interface TouchMenuMessage { bHasVirtualMenus: boolean; unControllerIndex: number; appID: number; -} \ No newline at end of file +} diff --git a/src/deck-components/steam-client/InstallFolder.ts b/src/deck-components/steam-client/InstallFolder.ts index 8f55a339..fe62ae40 100644 --- a/src/deck-components/steam-client/InstallFolder.ts +++ b/src/deck-components/steam-client/InstallFolder.ts @@ -7,97 +7,90 @@ import {AppError} from "./App"; export interface InstallFolder { /** * Adds a Steam Library folder to the Steam client. - * @param {string} steamLibraryPath - The path of the Steam Library folder to be added. - * @returns {Promise} - A Promise that resolves to the index of the added folder. + * @param steamLibraryPath The path of the Steam Library folder to be added. + * @returns A Promise that resolves to the index of the added folder. */ AddInstallFolder(steamLibraryPath: string): Promise; /** * Opens the file explorer to browse files in a specific Steam Library folder. - * @param {number} folderIndex - The index of the folder to be opened. - * @returns {void} + * @param folderIndex The index of the folder to be opened. */ BrowseFilesInFolder(folderIndex: number): void; /** * Cancels the current move operation for moving game content. - * @returns {void} */ CancelMove(): void; /** * Retrieves a list of installed Steam Library folders. - * @returns {Promise} - A Promise that resolves to an array of SteamInstallFolder objects. + * @returns A Promise that resolves to an array of SteamInstallFolder objects. */ GetInstallFolders(): Promise; /** * Retrieves a list of potential Steam Library folders that can be added. - * @returns {Promise} - A Promise that resolves to an array of PotentialInstallFolder objects. + * @returns A Promise that resolves to an array of PotentialInstallFolder objects. */ GetPotentialFolders(): Promise; /** * Moves the installation folder for a specific app to another Steam Library folder. - * @param {number} appId - The ID of the application to be moved. - * @param {number} folderIndex - The index of the target Steam Library folder. - * @returns {void} + * @param appId The ID of the application to be moved. + * @param folderIndex The index of the target Steam Library folder. */ MoveInstallFolderForApp(appId: number, folderIndex: number): void; /** * Refreshes the list of installed Steam Library folders. - * @returns {any} - A Promise or response indicating the refresh operation. + * @returns A Promise or response indicating the refresh operation. */ RefreshFolders(): any; /** * Registers a callback function to be called when changes occur in Steam Install Folders. - * @param {function} callback - The callback function to be called. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @param callback The callback function to be called. + * @returns An object that can be used to unregister the callback. */ - RegisterForInstallFolderChanges(callback: (folderChange: FolderChange) => void): Unregisterable | any; + RegisterForInstallFolderChanges(callback: (folderChange: FolderChange) => void): Unregisterable; /** * Registers a callback function to be called when moving game content progresses. - * @param {function} callback - The callback function to be called. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @param callback The callback function to be called. + * @returns An object that can be used to unregister the callback. */ - RegisterForMoveContentProgress(callback: (moveContentProgress: MoveContentProgress) => void): Unregisterable | any; + RegisterForMoveContentProgress(callback: (moveContentProgress: MoveContentProgress) => void): Unregisterable; /** * Registers a callback function to be called when repairing an install folder is finished. - * @param {function} callback - The callback function to be called. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @param callback The callback function to be called. + * @returns An object that can be used to unregister the callback. */ - RegisterForRepairFolderFinished(callback: (folderChange: FolderChange) => void): Unregisterable | any; + RegisterForRepairFolderFinished(callback: (folderChange: FolderChange) => void): Unregisterable; /** * Removes a Steam Library folder from the Steam client. - * @param {number} folderIndex - The index of the folder to be removed. - * @returns {void} + * @param folderIndex The index of the folder to be removed. */ RemoveInstallFolder(folderIndex: number): void; /** * Repairs an installed Steam Library folder. - * @param {number} folderIndex - The index of the folder to be repaired. - * @returns {void} + * @param folderIndex The index of the folder to be repaired. */ RepairInstallFolder(folderIndex: number): void; /** * Sets a specific Steam Library folder as the default install folder. - * @param {number} folderIndex - The index of the folder to be set as default. - * @returns {void} + * @param folderIndex The index of the folder to be set as default. */ SetDefaultInstallFolder(folderIndex: number): void; /** * Sets a user-defined label for a specific Steam Library folder. - * @param {number} folderIndex - The index of the folder to be labeled. - * @param {string} userLabel - The label to be assigned to the folder. - * @returns {void} + * @param folderIndex The index of the folder to be labeled. + * @param userLabel The label to be assigned to the folder. */ SetFolderLabel(folderIndex: number, userLabel: string): void; } @@ -172,4 +165,4 @@ export interface MoveContentProgress { strBytesMoved: string; strTotalBytesToMove: string; nFilesMoved: number; -} \ No newline at end of file +} diff --git a/src/deck-components/steam-client/Installs.ts b/src/deck-components/steam-client/Installs.ts index 6272eb14..db0c068c 100644 --- a/src/deck-components/steam-client/Installs.ts +++ b/src/deck-components/steam-client/Installs.ts @@ -7,83 +7,75 @@ import {AppError} from "./App"; export interface Installs { /** * Cancels the installation wizard if it is open. - * @returns {void} */ CancelInstall(): void; /** * Continues and starts the installation if the wizard is still open. - * @returns {void} */ ContinueInstall(): void; /** * Retrieves information from the last opened or currently opened installation wizard. - * @returns {Promise} A Promise that resolves to the InstallInfo. + * @returns A Promise that resolves to the InstallInfo. */ GetInstallManagerInfo(): Promise; /** * Opens the restore from backup installer wizard for a specific app. - * @param {string} appBackupPath - The backup path of the app. - * @returns {void} + * @param appBackupPath The backup path of the app. */ OpenInstallBackup(appBackupPath: string): void; /** * Opens the installation wizard for specified app IDs. - * @param {number[]} appIds - An array of app IDs to install. - * @returns {void} + * @param appIds An array of app IDs to install. */ OpenInstallWizard(appIds: number[]): void; /** * Opens the uninstall wizard for specified app IDs. - * @param {number[]} appIds - An array of app IDs to uninstall. - * @param {boolean} dontPrompt - Whether to *not* prompt the user to uninstall. - * @returns {void} + * @param appIds An array of app IDs to uninstall. + * @param dontPrompt Whether to *not* prompt the user to uninstall. */ OpenUninstallWizard(appIds: number[], dontPrompt: boolean): void; - RegisterForShowConfirmUninstall: Unregisterable | any; // Broken? doesn't seem to work + RegisterForShowConfirmUninstall: Unregisterable; // Broken? doesn't seem to work /** * Registers a callback function to be called when the "Failed Uninstall" dialog is shown. - * @param {function} callback - The callback function to be called when the dialog is shown. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @param callback The callback function to be called when the dialog is shown. + * @returns An object that can be used to unregister the callback. */ - RegisterForShowFailedUninstall(callback: (appId: number, reason: AppError) => void): Unregisterable | any; + RegisterForShowFailedUninstall(callback: (appId: number, reason: AppError) => void): Unregisterable; /** * Registers a callback function to be called when the installation wizard is shown. - * @param {function} callback - The callback function to be called. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @param callback The callback function to be called. + * @returns An object that can be used to unregister the callback. */ - RegisterForShowInstallWizard(callback: (data: InstallInfo) => void): Unregisterable | any; + RegisterForShowInstallWizard(callback: (data: InstallInfo) => void): Unregisterable; RegisterForShowRegisterCDKey: any; /** * Sets a list of app identifiers for downloads in the installation wizard. - * @param {number[]} appIds - An array of app IDs to set. - * @returns {void} + * @param appIds An array of app IDs to set. * @remarks The wizard will not reflect this change immediately, but changing another option will. */ SetAppList(appIds: number[]): void; /** * Sets the options for creating shortcuts in the installation wizard. - * @param {boolean} bDesktopShortcut - Whether to create a desktop shortcut. - * @param {boolean} bSystemMenuShortcut - Whether to create a system menu shortcut. - * @returns {void} + * @param bDesktopShortcut Whether to create a desktop shortcut. + * @param bSystemMenuShortcut Whether to create a system menu shortcut. * @remarks The wizard will not reflect this change immediately, but changing another option will. */ SetCreateShortcuts(bDesktopShortcut: boolean, bSystemMenuShortcut: boolean): void; /** * Sets the install folder for the installation wizard using an install folder index. - * @param {number} folderIndex - The index of the install folder. - * @returns {void} + * @param folderIndex The index of the install folder. * @remarks The wizard will not reflect this change immediately, but changing another option will. */ SetInstallFolder(folderIndex: number): void; @@ -136,4 +128,4 @@ export enum EInstallManagerState { Complete = 14, Failed = 15, Canceled = 16, -} \ No newline at end of file +} diff --git a/src/deck-components/steam-client/Messaging.ts b/src/deck-components/steam-client/Messaging.ts index 62505338..07f83f8b 100644 --- a/src/deck-components/steam-client/Messaging.ts +++ b/src/deck-components/steam-client/Messaging.ts @@ -7,7 +7,7 @@ export interface Messaging { RegisterForMessages( section: string, callback: (section: string, param1: string, message: string) => void, - ): Unregisterable | any; + ): Unregisterable; /* function m(e) { @@ -18,4 +18,4 @@ export interface Messaging { SteamClient.Messaging.PostMessage("FriendsUI", "AcceptedRemotePlayInvite", JSON.stringify({id: this.appID})) : SteamClient.Messaging.PostMessage("FriendsUI", "AcceptedGameInvite", JSON.stringify({id: this.appID})) */ PostMessage(section: string, param1: string, message: string): void; -} \ No newline at end of file +} diff --git a/src/deck-components/steam-client/Music.ts b/src/deck-components/steam-client/Music.ts index 5fb0661e..d004ffc7 100644 --- a/src/deck-components/steam-client/Music.ts +++ b/src/deck-components/steam-client/Music.ts @@ -15,8 +15,8 @@ export interface Music { IncreaseVolume(): void; /** - * @param {number} param0 - Unknown parameter usage. - * @param {number} param1 - Unknown parameter usage. + * @param param0 Unknown parameter usage. + * @param param1 Unknown parameter usage. * @todo: unknown parameter usages, I have tried soundtrack identifier + track index and in reverse as well */ PlayEntry(param0: number, param1: number): void; @@ -33,39 +33,39 @@ export interface Music { /** * Registers a callback function to be called when music playback changes. - * @param {function} callback - The callback function to be called. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @param callback The callback function to be called. + * @returns An object that can be used to unregister the callback. */ - RegisterForMusicPlaybackChanges(callback: (param0: boolean | MusicTrack) => void): Unregisterable | any; + RegisterForMusicPlaybackChanges(callback: (param0: boolean | MusicTrack) => void): Unregisterable; /** * Registers a callback function to be called when the music playback position changes. - * @param {function} callback - The callback function to be called. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @param callback The callback function to be called. + * @returns An object that can be used to unregister the callback. */ - RegisterForMusicPlaybackPosition(callback: (position: number) => void): Unregisterable | any; + RegisterForMusicPlaybackPosition(callback: (position: number) => void): Unregisterable; /** * Sets the playback position of the music track. - * @param {number} position - The position to set in seconds. + * @param position The position to set in seconds. */ SetPlaybackPosition(position: number): void; /** * Sets the repeat status for music playback. - * @param {MusicRepeatStatus} status - The repeat status. + * @param status The repeat status. */ SetPlayingRepeatStatus(status: MusicRepeatStatus): void; /** * Sets the shuffle status for music playback. - * @param {boolean} value - True to enable shuffle, false to disable shuffle. + * @param value True to enable shuffle, false to disable shuffle. */ SetPlayingShuffled(value: boolean): void; /** * Sets the volume for music playback. - * @param {number} volume - The volume level to set. + * @param volume The volume level to set. * @remarks Ranges from 0 to 100. */ SetVolume(volume: number): void; @@ -103,4 +103,4 @@ export enum MusicRepeatStatus { All = 1, Once = 2, Max = 3, -} \ No newline at end of file +} diff --git a/src/deck-components/steam-client/Notifications.ts b/src/deck-components/steam-client/Notifications.ts index dbb25933..566b3e81 100644 --- a/src/deck-components/steam-client/Notifications.ts +++ b/src/deck-components/steam-client/Notifications.ts @@ -7,11 +7,11 @@ import {JsPbMessage, Unregisterable} from "./index"; export interface Notifications { /** * If `data` is deserialized, returns one of the following here: {@link Notifications} - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @returns An object that can be used to unregister the callback. */ RegisterForNotifications( callback: (notificationIndex: number, type: EClientNotificationType, data: ArrayBuffer) => void, - ): Unregisterable | any; + ): Unregisterable; } export enum EClientNotificationType { diff --git a/src/deck-components/steam-client/OpenVR.ts b/src/deck-components/steam-client/OpenVR.ts index dde8a9af..25ed556a 100644 --- a/src/deck-components/steam-client/OpenVR.ts +++ b/src/deck-components/steam-client/OpenVR.ts @@ -19,19 +19,19 @@ export interface OpenVR { QuitAllVR(): any; - RegisterForButtonPress: Unregisterable | any; + RegisterForButtonPress: Unregisterable; - RegisterForHMDActivityLevelChanged(callback: (m_eHMDActivityLevel: EHMDActivityLevel) => void): Unregisterable | any; + RegisterForHMDActivityLevelChanged(callback: (m_eHMDActivityLevel: EHMDActivityLevel) => void): Unregisterable; - RegisterForInstallDialog: Unregisterable | any; + RegisterForInstallDialog: Unregisterable; - RegisterForStartupErrors(callback: (clientError: any, initError: any, initErrorString: string) => void): Unregisterable | any; + RegisterForStartupErrors(callback: (clientError: any, initError: any, initErrorString: string) => void): Unregisterable; - RegisterForVRHardwareDetected(callback: (m_bHMDPresent: any, m_bHMDHardwareDetected: any, m_strHMDName: any) => void): Unregisterable | any; + RegisterForVRHardwareDetected(callback: (m_bHMDPresent: any, m_bHMDHardwareDetected: any, m_strHMDName: any) => void): Unregisterable; - RegisterForVRModeChange(callback: (m_bIsVRRunning: boolean) => void): Unregisterable | any; + RegisterForVRModeChange(callback: (m_bIsVRRunning: boolean) => void): Unregisterable; - RegisterForVRSceneAppChange(callback: (param0: number) => void): Unregisterable | any; + RegisterForVRSceneAppChange(callback: (param0: number) => void): Unregisterable; SetOverlayInteractionAffordance: any; @@ -43,9 +43,9 @@ export interface OpenVR { export interface VRDevice { BIsConnected: any; - RegisterForDeviceConnectivityChange: Unregisterable | any; + RegisterForDeviceConnectivityChange: Unregisterable; - RegisterForVRDeviceSeenRecently(callback: (m_bVRDeviceSeenRecently: any) => void): Unregisterable | any; + RegisterForVRDeviceSeenRecently(callback: (m_bVRDeviceSeenRecently: any) => void): Unregisterable; } export interface DeviceProperties { @@ -54,7 +54,7 @@ export interface DeviceProperties { GetFloatDeviceProperty: any; GetInt32DeviceProperty: any; GetStringDeviceProperty: any; - RegisterForDevicePropertyChange: Unregisterable | any; + RegisterForDevicePropertyChange: Unregisterable; } export interface Keyboard { @@ -63,7 +63,7 @@ export interface Keyboard { /** * {@link EKeyboardFlags} could be useful here */ - RegisterForStatus(callback: (m_bIsKeyboardOpen: boolean, m_eKeyboardFlags: number, m_sInitialKeyboardText: string) => void): Unregisterable | any; + RegisterForStatus(callback: (m_bIsKeyboardOpen: boolean, m_eKeyboardFlags: number, m_sInitialKeyboardText: string) => void): Unregisterable; SendDone(): any; @@ -87,7 +87,7 @@ export interface PathProperties { export interface VRNotifications { HideCustomNotification: any; - RegisterForNotificationEvent: Unregisterable | any; + RegisterForNotificationEvent: Unregisterable; ShowCustomNotification: any; } @@ -96,10 +96,10 @@ export interface VROverlay { IsDashboardVisible(): Promise; - RegisterForButtonPress: Unregisterable | any; - RegisterForCursorMovement: Unregisterable | any; - RegisterForThumbnailChanged: Unregisterable | any; - RegisterForVisibilityChanged: Unregisterable | any; + RegisterForButtonPress: Unregisterable; + RegisterForCursorMovement: Unregisterable; + RegisterForThumbnailChanged: Unregisterable; + RegisterForVisibilityChanged: Unregisterable; ShowDashboard: any; SwitchToDashboardOverlay(param0: string): void; diff --git a/src/deck-components/steam-client/Overlay.ts b/src/deck-components/steam-client/Overlay.ts index fb62fefb..867557b8 100644 --- a/src/deck-components/steam-client/Overlay.ts +++ b/src/deck-components/steam-client/Overlay.ts @@ -3,7 +3,6 @@ import {EBrowserType, UIMode, Unregisterable} from "./index"; export interface Overlay { /** * Destroys the gamepad UI desktop configurator window if open. - * @returns {void} */ DestroyGamePadUIDesktopConfiguratorWindow(): void; @@ -13,53 +12,53 @@ export interface Overlay { HandleProtocolForOverlayBrowser(appId: number, protocol: string): any; - RegisterForActivateOverlayRequests: Unregisterable | any; + RegisterForActivateOverlayRequests: Unregisterable; /** * Registers a callback function to be called when a microtransaction authorization is requested. - * @param {function} callback - The callback function to be called. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @param callback The callback function to be called. + * @returns An object that can be used to unregister the callback. */ RegisterForMicroTxnAuth( callback: (appId: number, microTxnId: string, realm: SteamRealm, microTxnUrl: string) => void, - ): Unregisterable | any; + ): Unregisterable; /** * Registers a callback function to be called when a microtransaction authorization is dismissed by the user in Steam's authorization page. - * @param {function} callback - The callback function to be called. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @param callback The callback function to be called. + * @returns An object that can be used to unregister the callback. */ - RegisterForMicroTxnAuthDismiss(callback: (appId: number, microTxnId: string) => void): Unregisterable | any; + RegisterForMicroTxnAuthDismiss(callback: (appId: number, microTxnId: string) => void): Unregisterable; RegisterForNotificationPositionChanged( callback: (appId: any, position: NotificationPosition, horizontalInset: number, verticalInset: number) => void, - ): Unregisterable | any; + ): Unregisterable; /** * Registers a callback function to be called when an overlay is activated or closed. - * @param {function} callback - The callback function to be called. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @param callback The callback function to be called. + * @returns An object that can be used to unregister the callback. */ RegisterForOverlayActivated( callback: (overlayProcessPid: number, appId: number, active: boolean, param3: boolean) => void, - ): Unregisterable | any; + ): Unregisterable; /** * Registers a callback function to be called when the overlay browser protocols change. - * @param {function} callback - The callback function to be called. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @param callback The callback function to be called. + * @returns An object that can be used to unregister the callback. */ RegisterForOverlayBrowserProtocols( callback: (browseProtocols: OverlayBrowserProtocols) => void, - ): Unregisterable | any; + ): Unregisterable; /** * Registers **the** callback function to be called when the overlay browser information changes. - * @param {function} callback - The callback function to be called when the overlay browser information changes. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @param callback The callback function to be called when the overlay browser information changes. + * @returns An object that can be used to unregister the callback. * @remarks Do Not Use, this will break the overlay unless you know what you are doing. */ - RegisterOverlayBrowserInfoChanged(callback: () => void): Unregisterable | any; + RegisterOverlayBrowserInfoChanged(callback: () => void): Unregisterable; SetOverlayState(appId: number, uiComposition: UIComposition): any; } @@ -121,4 +120,4 @@ export enum UIComposition { * events to the Gamescope foreground app (game) instead of Steam. */ OverlayKeyboard = 4, -} \ No newline at end of file +} diff --git a/src/deck-components/steam-client/Parental.ts b/src/deck-components/steam-client/Parental.ts index ccb94cb3..4e061b68 100644 --- a/src/deck-components/steam-client/Parental.ts +++ b/src/deck-components/steam-client/Parental.ts @@ -6,22 +6,21 @@ import {Result, Unregisterable} from "./index"; export interface Parental { /** * Locks the parental control settings. - * @returns {void} */ LockParentalLock(): void; /** * Registers a callback function to be invoked when parental settings change. - * @param {(parentalSettings: ParentalSettings) => void} callback - The callback function to be invoked when parental settings change. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @param callback The callback function to be invoked when parental settings change. + * @returns An object that can be used to unregister the callback. */ - RegisterForParentalSettingsChanges(callback: (parentalSettings: ParentalSettings) => void): Unregisterable | any; + RegisterForParentalSettingsChanges(callback: (parentalSettings: ParentalSettings) => void): Unregisterable; /** * Unlocks the parental lock with the provided PIN. - * @param {string} pin - The 4-digit PIN to unlock the parental lock. - * @param {boolean} param1 - Additional parameter. // Todo: Unknown usage. - * @returns {Promise} - A Promise that resolves to a number representing the result of the unlock operation. + * @param pin The 4-digit PIN to unlock the parental lock. + * @param param1 Additional parameter. // Todo: Unknown usage. + * @returns A Promise that resolves to a number representing the result of the unlock operation. */ UnlockParentalLock(pin: string, param1: boolean): Promise; } @@ -76,4 +75,4 @@ interface AppList { * Key-value pairs where the key is the `appId` (e.g., "App_123456") and the value indicates whether the appId is allowed during parental lock. */ [appId: string]: number; -} \ No newline at end of file +} diff --git a/src/deck-components/steam-client/RemotePlay.ts b/src/deck-components/steam-client/RemotePlay.ts index 4d8edcd3..3751bcc2 100644 --- a/src/deck-components/steam-client/RemotePlay.ts +++ b/src/deck-components/steam-client/RemotePlay.ts @@ -39,45 +39,45 @@ export interface RemotePlay { InstallAudioDriver: any; InstallInputDriver: any; MoveControllerToSlot: any; - RegisterForAdditionalParentalBlocks: Unregisterable | any; - RegisterForAudioDriverPrompt: Unregisterable | any; - RegisterForBitrateOverride: Unregisterable | any; - RegisterForControllerIndexSet: Unregisterable | any; + RegisterForAdditionalParentalBlocks: Unregisterable; + RegisterForAudioDriverPrompt: Unregisterable; + RegisterForBitrateOverride: Unregisterable; + RegisterForControllerIndexSet: Unregisterable; - RegisterForDevicesChanges(callback: (devicesChange: RemotePlayDevice[]) => void): Unregisterable | any; + RegisterForDevicesChanges(callback: (devicesChange: RemotePlayDevice[]) => void): Unregisterable; - RegisterForGroupCreated: Unregisterable | any; - RegisterForGroupDisbanded: Unregisterable | any; - RegisterForInputDriverPrompt: Unregisterable | any; - RegisterForInputDriverRestartNotice: Unregisterable | any; + RegisterForGroupCreated: Unregisterable; + RegisterForGroupDisbanded: Unregisterable; + RegisterForInputDriverPrompt: Unregisterable; + RegisterForInputDriverRestartNotice: Unregisterable; RegisterForInputUsed( callback: (steam64Id: string, type: ClientUsedInputType, guestId: number) => void, - ): Unregisterable | any; // only fires on host + ): Unregisterable; // only fires on host - RegisterForInviteResult: Unregisterable | any; + RegisterForInviteResult: Unregisterable; RegisterForNetworkUtilizationUpdate( callback: (steam64Id: string, guestId: number, networkUtilization: number, networkDuration: number) => void, - ): Unregisterable | any; // only fires on host + ): Unregisterable; // only fires on host - RegisterForPlaceholderStateChanged(callback: (isShowingPlaceholder: boolean) => void): Unregisterable | any; + RegisterForPlaceholderStateChanged(callback: (isShowingPlaceholder: boolean) => void): Unregisterable; - RegisterForPlayerInputSettingsChanged: Unregisterable | any; + RegisterForPlayerInputSettingsChanged: Unregisterable; - RegisterForQualityOverride(callback: (hostStreamingQualityOverride: number) => void): Unregisterable | any; + RegisterForQualityOverride(callback: (hostStreamingQualityOverride: number) => void): Unregisterable; - RegisterForRemoteClientLaunchFailed: Unregisterable | any; + RegisterForRemoteClientLaunchFailed: Unregisterable; - RegisterForRemoteClientStarted(callback: (steam64Id: string, appId: number) => void): Unregisterable | any; // only fires on client + RegisterForRemoteClientStarted(callback: (steam64Id: string, appId: number) => void): Unregisterable; // only fires on client - RegisterForRemoteClientStopped(callback: (steam64Id: string, appId: number) => void): Unregisterable | any; // only fires on client + RegisterForRemoteClientStopped(callback: (steam64Id: string, appId: number) => void): Unregisterable; // only fires on client - RegisterForSessionStarted(callback: (steam64Id: any, gameId: any, guestId: any) => void): Unregisterable | any; + RegisterForSessionStarted(callback: (steam64Id: any, gameId: any, guestId: any) => void): Unregisterable; - RegisterForSessionStopped(callback: (steam64Id: any, guestId: any) => void): Unregisterable | any; + RegisterForSessionStopped(callback: (steam64Id: any, guestId: any) => void): Unregisterable; - RegisterForSettingsChanges(callback: (remotePlaySettings: RemotePlaySettings) => void): Unregisterable | any; + RegisterForSettingsChanges(callback: (remotePlaySettings: RemotePlaySettings) => void): Unregisterable; SetClientStreamingBitrate(bitrate: number): void; @@ -162,4 +162,4 @@ export enum StreamP2PScope { OnlyMe = 2, Friends = 3, Everyone = 4, -} \ No newline at end of file +} diff --git a/src/deck-components/steam-client/Screenshots.ts b/src/deck-components/steam-client/Screenshots.ts index a5c97f11..0e835e76 100644 --- a/src/deck-components/steam-client/Screenshots.ts +++ b/src/deck-components/steam-client/Screenshots.ts @@ -4,101 +4,99 @@ export interface Screenshots { /** * Deletes a local screenshot. - * @param {string} appId - The ID of the application. - * @param {number} screenshotIndex - The index of the local screenshot. - * @returns {Promise} - A Promise that resolves to a boolean value indicating whether the deletion was successful. + * @param appId The ID of the application. + * @param screenshotIndex The index of the local screenshot. + * @returns A Promise that resolves to a boolean value indicating whether the deletion was successful. */ DeleteLocalScreenshot(appId: string, screenshotIndex: number): Promise; /** * Retrieves all local screenshots for all applications. - * @returns {Promise} - A Promise that resolves to an array of Screenshot objects. + * @returns A Promise that resolves to an array of Screenshot objects. */ GetAllAppsLocalScreenshots(): Promise; /** * Retrieves the count of all local screenshots for all applications. - * @returns {Promise} - A Promise that resolves to the count of local screenshots. + * @returns A Promise that resolves to the count of local screenshots. */ GetAllAppsLocalScreenshotsCount(): Promise; /** * Retrieves a range of local screenshots for all applications. - * @param {number} start - The starting index of the screenshot range. - * @param {number} end - The ending index of the screenshot range. - * @returns {Promise} - A Promise that resolves to an array of Screenshot objects within the specified range. + * @param start The starting index of the screenshot range. + * @param end The ending index of the screenshot range. + * @returns A Promise that resolves to an array of Screenshot objects within the specified range. */ GetAllAppsLocalScreenshotsRange(start: number, end: number): Promise; /** * Retrieves all local screenshots. - * @returns {Promise} - A Promise that resolves to an array of Screenshot objects. + * @returns A Promise that resolves to an array of Screenshot objects. */ GetAllLocalScreenshots(): Promise; /** * Retrieves the game associated with a specific local screenshot index. - * @param {number} screenshotIndex - The index of the local screenshot. - * @returns {Promise} - A Promise that resolves to the ID of the game associated with the screenshot. + * @param screenshotIndex The index of the local screenshot. + * @returns A Promise that resolves to the ID of the game associated with the screenshot. */ GetGameWithLocalScreenshots(screenshotIndex: number): Promise; /** * Retrieves the last taken local screenshot. - * @returns {Promise} - A Promise that resolves to the last taken local screenshot. + * @returns A Promise that resolves to the last taken local screenshot. */ GetLastScreenshotTaken(): Promise; /** * Retrieves a specific local screenshot for an application. - * @param {string} appId - The ID of the application. - * @param {number} screenshotIndex - The index of the local screenshot. - * @returns {Promise} - A Promise that resolves to the requested local screenshot. + * @param appId The ID of the application. + * @param screenshotIndex The index of the local screenshot. + * @returns A Promise that resolves to the requested local screenshot. */ GetLocalScreenshotByHandle(appId: string, screenshotIndex: number): Promise; /** * Retrieves the count of local screenshots for a specific application. - * @param {number} appId - The ID of the application. - * @returns {Promise} - A Promise that resolves to the count of local screenshots for the application. + * @param appId The ID of the application. + * @returns A Promise that resolves to the count of local screenshots for the application. */ GetLocalScreenshotCount(appId: number): Promise; /** * Retrieves the number of games with local screenshots. - * @returns {Promise} - A Promise that resolves to the number of games with local screenshots. + * @returns A Promise that resolves to the number of games with local screenshots. */ GetNumGamesWithLocalScreenshots(): Promise; /** * Gets total screenshot usage in the specified library folder. * @param path Library folder path. - * @returns {Promise} A Promise that resolves to the number of taken space in bytes. + * @returns A Promise that resolves to the number of taken space in bytes. */ GetTotalDiskSpaceUsage(path: string): Promise; /** * Opens a local screenshot in the system image viewer. * If the screenshot index is invalid, this function opens the screenshots directory for the specified application ID. - * @param {string} appId - The ID of the application. - * @param {number} screenshotIndex - The index of the local screenshot. - * @returns {void} + * @param appId The ID of the application. + * @param screenshotIndex The index of the local screenshot. */ ShowScreenshotInSystemViewer(appId: string, screenshotIndex: number): void; /** * Opens the folder containing local screenshots for a specific application. - * @param {string} appId - The ID of the application. - * @returns {void} + * @param appId The ID of the application. */ ShowScreenshotsOnDisk(appId: string): void; /** * Uploads a local screenshot. - * @param {string} appId - The ID of the application. - * @param {number} localScreenshot_hHandle - The handle of the local screenshot. - * @param {number} filePrivacyState - The privacy state of the screenshot file. - * @returns {Promise} - A Promise that resolves to a boolean value indicating whether the upload was successful. + * @param appId The ID of the application. + * @param localScreenshot_hHandle The handle of the local screenshot. + * @param filePrivacyState The privacy state of the screenshot file. + * @returns A Promise that resolves to a boolean value indicating whether the upload was successful. */ UploadLocalScreenshot( appId: string, @@ -128,4 +126,4 @@ export enum FilePrivacyState { FriendsOnly = 4, Public = 8, Unlisted = 16, -} \ No newline at end of file +} diff --git a/src/deck-components/steam-client/ServerBrowser.ts b/src/deck-components/steam-client/ServerBrowser.ts index fcfb9dec..5c7386d0 100644 --- a/src/deck-components/steam-client/ServerBrowser.ts +++ b/src/deck-components/steam-client/ServerBrowser.ts @@ -6,16 +6,15 @@ import {OperationResponse, Unregisterable} from "./index"; export interface ServerBrowser { /** * Adds a favorite server. - * @param {ServerBrowserServerFull} server - The server to add. - * @returns {Promise} A Promise that resolves to an empty string if successful, `Invalid/missing IPv4?` if failed. - * @todo Refreshed the favorite servers list upon adding once, but doesn't now. :-( + * @param server The server to add. + * @returns A Promise that resolves to an empty string if successful, `Invalid/missing IPv4?` if failed. */ AddFavoriteServer(server: ServerBrowserServerFull): Promise; /** * Adds a favorite server by IP. - * @param {string} ip - The IP to add to favorite servers. - * @returns {Promise} A Promise that resolves to an empty string if successful, localization string if failed. + * @param ip The IP to add to favorite servers. + * @returns A Promise that resolves to an empty string if successful, localization string if failed. */ AddFavoriteServersByIP(ip: string): Promise; @@ -23,37 +22,36 @@ export interface ServerBrowser { /** * Connects to a server from a given dialog. - * @param {number} dialogId - The dialog ID to use. - * @param {string} password - Server password, empty if none. - * @returns {Promise} A Promise that resolves to a connection status. + * @param dialogId The dialog ID to use. + * @param password Server password, empty if none. + * @returns A Promise that resolves to a connection status. */ ConnectToServer(dialogId: number, password: string): Promise; /** * Creates a server info dialog, on which your friend is playing on. - * @param {number} pid - 0 - * @param {string} steamId - A Steam64 ID of a friend. - * @returns {void} + * @param pid 0 + * @param steamId A Steam64 ID of a friend. */ CreateFriendGameInfoDialog(pid: number, steamId: string): void; /** * Creates a server info dialog. - * @param {string} ip - The IP to create a dialog for. - * @param {number} port - The IP's port. - * @param {number} queryPort - - * @returns {Promise} A Promise that resolves to the current dialog ID. + * @param ip The IP to create a dialog for. + * @param port The IP's port. + * @param queryPort + * @returns A Promise that resolves to the current dialog ID. */ CreateServerGameInfoDialog(ip: string, port: number, queryPort: number): Promise; /** * Retrieves the server list. - * @param {number} appId - The game ID, 0 for every game. - * @param {ServerBrowserTab} queryType - The tab to use. - * @param {string[]} filters - Server filters. - * @param {function} serverCallback - What to do with the found server? - * @param {function} requestCompletedCallback - The callback function to be called when the request is completed. - * @returns {Promise} A Promise that resolves to the current server list request ID. + * @param appId The game ID, 0 for every game. + * @param queryType The tab to use. + * @param filters Server filters. + * @param serverCallback What to do with the found server? + * @param requestCompletedCallback The callback function to be called when the request is completed. + * @returns A Promise that resolves to the current server list request ID. * @throws Throws if the query type is unknown. * @throws Throws if the filter list isn't key/value pairs, i.e. of an even length. * @remarks Stops at 10000 if there are more servers to be found. @@ -107,107 +105,100 @@ export interface ServerBrowser { /** * Destroys the game info dialog functions (but not the window). - * @param {number} dialogId - The dialog ID to use. - * @returns {void} + * @param dialogId The dialog ID to use. * @remarks ServerBrowser.CancelServerQuery may throw if it tries to ping the server. */ DestroyGameInfoDialog(dialogId: number): void; /** * Stops retrieving the server list. - * @param {number} activeServerListRequestId - The active server request ID to use. - * @returns {void} + * @param activeServerListRequestId The active server request ID to use. */ DestroyServerListRequest(activeServerListRequestId: number): void; /** * Gets a list of games that support the server browser feature. - * @returns {Promise} A Promise that resolves to a list of games. + * @returns A Promise that resolves to a list of games. */ GetMultiplayerGames(): Promise; /** * Gets the server browser preferences. - * @returns {Promise} A Promise that resolves to server browser preferences. + * @returns A Promise that resolves to server browser preferences. */ GetServerListPreferences(): Promise; /** * Pings the server of a specified dialog ID. - * @param {number} dialogId - The dialog ID to use. - * @returns {Promise} + * @param dialogId The dialog ID to use. */ PingServer(dialogId: number): Promise; /** * Registers a callback function to be called when a server gets added to favorite servers. - * @param {function} callback - The callback function to be called. - * @returns {Unregisterable | any} An object that can be used to unregister the callback. + * @param callback The callback function to be called. + * @returns An object that can be used to unregister the callback. */ - RegisterForFavorites(callback: (list: ServerBrowserFavoritesAndHistory) => void): Unregisterable | any; + RegisterForFavorites(callback: (list: ServerBrowserFavoritesAndHistory) => void): Unregisterable; /** * Registers a callback function to be called when idk - * @param {number} dialogId - The dialog ID to use. - * @param {function} callback - The callback function to be called. - * @returns {Unregisterable | any} An object that can be used to unregister the callback. + * @param dialogId The dialog ID to use. + * @param callback The callback function to be called. + * @returns An object that can be used to unregister the callback. */ RegisterForFriendGamePlayed( dialogId: number, callback: (server: ServerBrowserFriendServer) => void, - ): Unregisterable | any; + ): Unregisterable; /** * Registers a callback function to be called when a server info dialog opens. - * @param {function} callback - The callback function to be called. - * @returns {Unregisterable | any} An object that can be used to unregister the callback. + * @param callback The callback function to be called. + * @returns An object that can be used to unregister the callback. */ - RegisterForGameInfoDialogs(callback: (dialogs: ServerBrowserDialog[]) => void): Unregisterable | any; + RegisterForGameInfoDialogs(callback: (dialogs: ServerBrowserDialog[]) => void): Unregisterable; /** * Registers a callback function to be called when player details get requested. - * @param {number} dialogId - The dialog ID to use. - * @param {function} callback - The callback function to be called. - * @returns {Unregisterable | any} An object that can be used to unregister the callback. + * @param dialogId The dialog ID to use. + * @param callback The callback function to be called. + * @returns An object that can be used to unregister the callback. */ RegisterForPlayerDetails( dialogId: number, callback: (player: ServerBrowserPlayer | ServerBrowserPlayerRefreshStatus) => void, - ): Unregisterable | any; + ): Unregisterable; /** * Registers a callback function to be called when a server gets pinged. - * @param {number} dialogId - The dialog ID to use. - * @param {function} callback - The callback function to be called. - * @returns {Unregisterable | any} An object that can be used to unregister the callback. + * @param dialogId The dialog ID to use. + * @param callback The callback function to be called. + * @returns An object that can be used to unregister the callback. */ - RegisterForServerInfo(dialogId: number, callback: (server: ServerBrowserServerFull) => void): Unregisterable | any; + RegisterForServerInfo(dialogId: number, callback: (server: ServerBrowserServerFull) => void): Unregisterable; /** * Removes a server from favorite servers. - * @param {ServerBrowserServer} server - The server to remove. - * @returns {void} + * @param server The server to remove. */ RemoveFavoriteServer(server: ServerBrowserServer): void; /** * Removes a server from history of played servers. - * @param {ServerBrowserServer} server - The server to remove. - * @returns {void} + * @param server The server to remove. */ RemoveHistoryServer(server: ServerBrowserServer): void; /** * Requests player details for a specific dialog. - * @param {number} dialogId - The dialog ID to use. - * @returns {Promise} + * @param dialogId The dialog ID to use. */ RequestPlayerDetails(dialogId: number): Promise; /** * Sets the server browser preferences. - * @param {ServerBrowserPreferences} prefs - Server list preferences. - * @returns {void} + * @param prefs Server list preferences. */ SetServerListPreferences(prefs: ServerBrowserPreferences): void; } @@ -362,4 +353,4 @@ export interface ServerBrowserPlayer extends ServerBrowserPlayerRefreshStatus { score: number; /** Time played on the server. */ timePlayed: number; -} \ No newline at end of file +} diff --git a/src/deck-components/steam-client/Settings.ts b/src/deck-components/steam-client/Settings.ts index 5d5bb06c..34f651cb 100644 --- a/src/deck-components/steam-client/Settings.ts +++ b/src/deck-components/steam-client/Settings.ts @@ -6,13 +6,11 @@ export interface Settings { /** * Clears HTTP cache located in `/appcache/httpcache`. - * @returns {void} */ ClearAllHTTPCaches(): void; /** * Clears download cache and logs you out. - * @returns {void} */ ClearDownloadCache(): void; @@ -30,7 +28,7 @@ export interface Settings { GetGlobalCompatTools(): Promise; /** - * @returns {Promise} A Promise that resolves to a ProtoBuf message. If deserialized, returns {@link MsgMonitorInfo}. + * @returns A Promise that resolves to a ProtoBuf message. If deserialized, returns {@link MsgMonitorInfo}. */ GetMonitorInfo(): Promise; @@ -47,21 +45,20 @@ export interface Settings { /** * Opens the Windows microphones dialog. - * @returns {void} */ OpenWindowsMicSettings(): void; - RegisterForMicVolumeUpdates: Unregisterable | any; + RegisterForMicVolumeUpdates: Unregisterable; /** * If `data` is deserialized, returns {@link MsgClientSettings}. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @returns An object that can be used to unregister the callback. */ - RegisterForSettingsArrayChanges(callback: (data: ArrayBuffer) => void): Unregisterable | any; + RegisterForSettingsArrayChanges(callback: (data: ArrayBuffer) => void): Unregisterable; - RegisterForSettingsChanges(callback: (steamSettings: SteamSettings) => void): Unregisterable | any; + RegisterForSettingsChanges(callback: (steamSettings: SteamSettings) => void): Unregisterable; - RegisterForTimeZoneChange(callback: (timezoneId: string) => void): Unregisterable | any; // When timezone is changed from settings, callback will return new timezoneId + RegisterForTimeZoneChange(callback: (timezoneId: string) => void): Unregisterable; // When timezone is changed from settings, callback will return new timezoneId ReinitMicSettings(): void; RequestDeviceAuthInfo(): void; @@ -86,8 +83,7 @@ export interface Settings { /** * Sets the "Don't save account credentials on this computer" option. - * @param {boolean} value - Whether to save account credentials. - * @returns {void} + * @param value Whether to save account credentials. */ SetSaveAccountCredentials(value: boolean): void; @@ -564,4 +560,4 @@ export enum HDRVisualization { Analysis = 2, HeatmapExtended = 3, HeatmapClassic = 4, -} \ No newline at end of file +} diff --git a/src/deck-components/steam-client/SharedConnection.ts b/src/deck-components/steam-client/SharedConnection.ts index 9894eab9..abfefe7b 100644 --- a/src/deck-components/steam-client/SharedConnection.ts +++ b/src/deck-components/steam-client/SharedConnection.ts @@ -11,11 +11,11 @@ export interface SharedConnection { // src\clientdll\clientsharedconnection.cpp (154) : m_mapSharedConnections.HasElement( hSharedConnection ) Close(hSharedConnection: number): void; - RegisterOnBinaryMessageReceived(hSharedConnection: number, callback: (data: ArrayBuffer) => void): Unregisterable | any; + RegisterOnBinaryMessageReceived(hSharedConnection: number, callback: (data: ArrayBuffer) => void): Unregisterable; - RegisterOnLogonInfoChanged(hSharedConnection: number, callback: (info: LogonInfo) => void): Unregisterable | any; + RegisterOnLogonInfoChanged(hSharedConnection: number, callback: (info: LogonInfo) => void): Unregisterable; - RegisterOnMessageReceived(hSharedConnection: number, callback: (param0: any) => void): Unregisterable | any; + RegisterOnMessageReceived(hSharedConnection: number, callback: (param0: any) => void): Unregisterable; SendMsg: any; SendMsgAndAwaitBinaryResponse: any; @@ -39,4 +39,4 @@ export interface LogonInfo { strSteamid: string; /** Country code. */ strUserCountry: string; -} \ No newline at end of file +} diff --git a/src/deck-components/steam-client/Stats.ts b/src/deck-components/steam-client/Stats.ts index c2fdc15b..c8e81313 100644 --- a/src/deck-components/steam-client/Stats.ts +++ b/src/deck-components/steam-client/Stats.ts @@ -7,4 +7,4 @@ export interface Stats { RecordActivationEvent(param0: string, param1: string): any; RecordDisplayEvent: any; -} \ No newline at end of file +} diff --git a/src/deck-components/steam-client/SteamChina.ts b/src/deck-components/steam-client/SteamChina.ts index 04a3e45e..d23e6c78 100644 --- a/src/deck-components/steam-client/SteamChina.ts +++ b/src/deck-components/steam-client/SteamChina.ts @@ -1,3 +1,3 @@ export interface SteamChina { GetCustomLauncherAppID(): Promise; -} \ No newline at end of file +} diff --git a/src/deck-components/steam-client/Storage.ts b/src/deck-components/steam-client/Storage.ts index 80e90852..aab95556 100644 --- a/src/deck-components/steam-client/Storage.ts +++ b/src/deck-components/steam-client/Storage.ts @@ -21,4 +21,4 @@ export interface Storage { SetObject(key: string, value: any): Promise; SetString(key: string, value: string): Promise; -} \ No newline at end of file +} diff --git a/src/deck-components/steam-client/Streaming.ts b/src/deck-components/steam-client/Streaming.ts index aadef786..6b6c9c00 100644 --- a/src/deck-components/steam-client/Streaming.ts +++ b/src/deck-components/steam-client/Streaming.ts @@ -8,48 +8,48 @@ export interface Streaming { /** * Registers a callback function to be called when the streaming client finishes. - * @param {function} callback - The callback function to be called. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @param callback The callback function to be called. + * @returns An object that can be used to unregister the callback. */ - RegisterForStreamingClientFinished(callback: (code: number, result: string) => void): Unregisterable | any; + RegisterForStreamingClientFinished(callback: (code: number, result: string) => void): Unregisterable; /** * Registers a callback function to be called when there is progress in the launch of the streaming client. - * @param {function} callback - The callback function to be called. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @param callback The callback function to be called. + * @returns An object that can be used to unregister the callback. */ RegisterForStreamingClientLaunchProgress( callback: (actionType: string, taskDetails: string, done: number, total: number) => void, - ): Unregisterable | any; + ): Unregisterable; /** * Registers a callback function to be called when the streaming client is started (e.g., when clicking the stream button). - * @param {function} callback - The callback function to be called. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @param callback The callback function to be called. + * @returns An object that can be used to unregister the callback. */ - RegisterForStreamingClientStarted(callback: (appId: number) => void): Unregisterable | any; + RegisterForStreamingClientStarted(callback: (appId: number) => void): Unregisterable; /** * Registers a callback function to be called when the streaming launch is complete. - * @param {function} callback - The callback function to be called. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @param callback The callback function to be called. + * @returns An object that can be used to unregister the callback. * @todo `code` is likely a code, 1 being it started, 10 being host computer is updating game, `result` just returns "complete" */ - RegisterForStreamingLaunchComplete(callback: (code: number, result: string) => void): Unregisterable | any; + RegisterForStreamingLaunchComplete(callback: (code: number, result: string) => void): Unregisterable; - RegisterForStreamingShowEula(callback: (appId: number) => any): Unregisterable | any; + RegisterForStreamingShowEula(callback: (appId: number) => any): Unregisterable; - RegisterForStreamingShowIntro(callback: (param0: any, param1: any) => any): Unregisterable | any; + RegisterForStreamingShowIntro(callback: (param0: any, param1: any) => any): Unregisterable; /** * Registers a callback function to be called when the streaming client receives launch options from the host. - * @param {function} callback - The callback function to be called. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @param callback The callback function to be called. + * @returns An object that can be used to unregister the callback. */ RegisterForStreamingShowLaunchOptions( callback: (appId: number, launchOptions: LaunchOption[]) => void, - ): Unregisterable | any; // Callback when streaming client receives launch options from host + ): Unregisterable; // Callback when streaming client receives launch options from host StreamingContinueStreamGame(): void; // existing game running on another streaming capable device StreamingSetLaunchOption(param0: any): any; -} \ No newline at end of file +} diff --git a/src/deck-components/steam-client/UI.ts b/src/deck-components/steam-client/UI.ts index e202ea46..4b1946b0 100644 --- a/src/deck-components/steam-client/UI.ts +++ b/src/deck-components/steam-client/UI.ts @@ -10,19 +10,18 @@ export interface UI { /** * Gets information about whether your OS will be unsupported in the future or not. - * @returns {Promise} */ GetOSEndOfLifeInfo(): Promise; /** * Retrieves the current UI mode. - * @returns {Promise} - A Promise that resolves to the current UI mode. + * @returns A Promise that resolves to the current UI mode. */ GetUIMode(): Promise; NotifyAppInitialized(): void; - RegisterDesiredSteamUIWindowsChanged(callback: () => void): Unregisterable | any; + RegisterDesiredSteamUIWindowsChanged(callback: () => void): Unregisterable; /** * Registers a callback function to be called when a convar's value gets changed. @@ -32,20 +31,19 @@ export interface UI { * @param convar The ConVar to watch. * @param callback The callback function to be called. */ - RegisterForClientConVar(convar: string, callback: (value: string) => void): Unregisterable | any; + RegisterForClientConVar(convar: string, callback: (value: string) => void): Unregisterable; - RegisterForErrorCondition(callback: (param0: number, param1: number) => void): Unregisterable | any; + RegisterForErrorCondition(callback: (param0: number, param1: number) => void): Unregisterable; - RegisterForKioskModeResetSignal(callback: () => void): Unregisterable | any; + RegisterForKioskModeResetSignal(callback: () => void): Unregisterable; - RegisterForUIModeChanged(callback: (mode: UIMode) => void): Unregisterable | any; + RegisterForUIModeChanged(callback: (mode: UIMode) => void): Unregisterable; ResetErrorCondition(): void; /** * Sets the UI mode to the specified value. - * @param {UIMode} mode - The UI mode to set. - * @returns {void} + * @param mode The UI mode to set. */ SetUIMode(mode: UIMode): void; } @@ -81,4 +79,4 @@ export interface SteamWindow { windowType: EWindowType; x: number; y: number; -} \ No newline at end of file +} diff --git a/src/deck-components/steam-client/URL.ts b/src/deck-components/steam-client/URL.ts index 1f951028..cd70fad7 100644 --- a/src/deck-components/steam-client/URL.ts +++ b/src/deck-components/steam-client/URL.ts @@ -16,11 +16,11 @@ export interface URL { /** * Registers a callback to be called when a steam:// URL gets executed. - * @param {string} section - `rungameid`, `open`, etc. - * @param {function} callback - The callback function to be called. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @param section `rungameid`, `open`, etc. + * @param callback The callback function to be called. + * @returns An object that can be used to unregister the callback. */ - RegisterForRunSteamURL(section: string, callback: (param0: number, url: string) => void): Unregisterable | any; + RegisterForRunSteamURL(section: string, callback: (param0: number, url: string) => void): Unregisterable; RegisterForSteamURLChanges(callback: () => void): void; } @@ -43,4 +43,4 @@ export interface SteamURLs { StoreCDN: SteamURL; WebAPI: SteamURL; LocalSSA: SteamURL; -} \ No newline at end of file +} diff --git a/src/deck-components/steam-client/Updates.ts b/src/deck-components/steam-client/Updates.ts index 85d4bb0a..2345a89b 100644 --- a/src/deck-components/steam-client/Updates.ts +++ b/src/deck-components/steam-client/Updates.ts @@ -9,9 +9,9 @@ export interface Updates { /** * If `data` is deserialized, returns {@link MsgSystemUpdateState}. - * @returns {Promise} A Promise that resolves to a ProtoBuf message. + * @returns A Promise that resolves to a ProtoBuf message. */ - RegisterForUpdateStateChanges(callback: (data: ArrayBuffer) => void): Unregisterable | any; + RegisterForUpdateStateChanges(callback: (data: ArrayBuffer) => void): Unregisterable; // 1 - Stable, 2 - Beta, 3 - Preview SelectOSBranch(branch: number): any; // enum? @@ -87,4 +87,4 @@ export enum UpdaterType { Test1 = 5, Test2 = 6, Dummy = 7, -} \ No newline at end of file +} diff --git a/src/deck-components/steam-client/User.ts b/src/deck-components/steam-client/User.ts index 3ebdbe5c..e3e6db8d 100644 --- a/src/deck-components/steam-client/User.ts +++ b/src/deck-components/steam-client/User.ts @@ -9,14 +9,12 @@ export interface User { /** * Tries to cancel Steam shutdown. - * @returns {void} * @remarks Used in the "Shutting down" dialog. */ CancelShutdown(): void; /** * Opens the "Change Account" dialog. - * @returns {void} */ ChangeUser(): void; @@ -26,25 +24,24 @@ export interface User { /** * Forces a shutdown while shutting down. - * @returns {void} * @remarks Used in the "Shutting down" dialog. */ ForceShutdown(): void; /** * Forgets an account's password. - * @param {string} accountName - Login of the account to forget. - * @returns {Promise} A Promise that resolves to a boolean indicating whether the operation succeeded or not. + * @param accountName Login of the account to forget. + * @returns A Promise that resolves to a boolean indicating whether the operation succeeded or not. */ ForgetPassword(accountName: string): Promise; /** * Gets your country code. - * @returns {Promise} A Promise that resolves to a string containing your country code. + * @returns A Promise that resolves to a string containing your country code. */ GetIPCountry(): Promise; - GetLoginProgress(callback: (param0: number, param1: number) => void): Unregisterable | any; + GetLoginProgress(callback: (param0: number, param1: number) => void): Unregisterable; GetLoginUsers(): Promise; @@ -58,32 +55,31 @@ export interface User { Reconnect(): void; - RegisterForConnectionAttemptsThrottled(callback: (data: ConnectionAttempt) => void): Unregisterable | any; + RegisterForConnectionAttemptsThrottled(callback: (data: ConnectionAttempt) => void): Unregisterable; RegisterForCurrentUserChanges(callback: (user: CurrentUser) => void): void; - RegisterForLoginStateChange(callback: (accountName: string, loginState: LoginState, loginResult: number, loginPercentage: number, param4: number) => void): Unregisterable | any; + RegisterForLoginStateChange(callback: (accountName: string, loginState: LoginState, loginResult: number, loginPercentage: number, param4: number) => void): Unregisterable; - RegisterForPrepareForSystemSuspendProgress(callback: (data: any) => void): Unregisterable | any; + RegisterForPrepareForSystemSuspendProgress(callback: (data: any) => void): Unregisterable; - RegisterForResumeSuspendedGamesProgress: Unregisterable | any; + RegisterForResumeSuspendedGamesProgress: Unregisterable; - RegisterForShutdownDone(callback: () => void): Unregisterable | any; + RegisterForShutdownDone(callback: () => void): Unregisterable; - RegisterForShutdownFailed: Unregisterable | any; + RegisterForShutdownFailed: Unregisterable; /** * Register a function to be executed when a shutdown start is detected. * @param callback The function to be executed on shutdown start. */ - RegisterForShutdownStart(callback: () => void): Unregisterable | any; + RegisterForShutdownStart(callback: () => void): Unregisterable; - RegisterForShutdownState: Unregisterable | any; + RegisterForShutdownState: Unregisterable; /** * Removes an account from remembered users. - * @param {string} accountName - The account to remove. - * @returns {void} + * @param accountName The account to remove. */ RemoveUser(accountName: string): void; @@ -102,10 +98,9 @@ export interface User { /** * Sets given login credentials, but don't log in to that account. - * @param {string} accountName - Account name. - * @param {string} password - Account password. - * @param {boolean} rememberMe - Whether to remember that account. - * @returns {void} + * @param accountName Account name. + * @param password Account password. + * @param rememberMe Whether to remember that account. */ SetLoginCredentials(accountName: string, password: string, rememberMe: boolean): void; @@ -115,7 +110,6 @@ export interface User { /** * Signs out and restarts Steam. - * @returnsn {void} */ SignOutAndRestart(): void; @@ -190,4 +184,4 @@ export interface SurveyEntry { export interface SurveySection { strSectionName: string; vecEntries: SurveyEntry[]; -} \ No newline at end of file +} diff --git a/src/deck-components/steam-client/WebChat.ts b/src/deck-components/steam-client/WebChat.ts index a1050f4c..12b99140 100644 --- a/src/deck-components/steam-client/WebChat.ts +++ b/src/deck-components/steam-client/WebChat.ts @@ -6,19 +6,19 @@ export interface WebChat { /** * Gets your Steam3 ID. - * @returns {Promise} A Promise that resolves to a Steam3 ID. + * @returns A Promise that resolves to a Steam3 ID. */ GetCurrentUserAccountID(): Promise; /** * Gets the current user's 64x64 avatar as a data URL. - * @returns {Promise} A Promise that resolves to the data URL. + * @returns A Promise that resolves to the data URL. */ GetLocalAvatarBase64(): Promise; /** * Gets the current user's nickname. - * @returns {Promise} A Promise that resolves to the nickname. + * @returns A Promise that resolves to the nickname. */ GetLocalPersonaName(): Promise; @@ -29,19 +29,19 @@ export interface WebChat { /** * Gets information about push-to-Talk. - * @returns {Promise} + * @returns */ GetPushToTalkEnabled(): Promise; /** * Gets the "Sign in to friends when Steam starts" option value. - * @returns {Promise} A Promise that resolves to a boolean indicating whether the option is enabled or not. + * @returns A Promise that resolves to a boolean indicating whether the option is enabled or not. */ GetSignIntoFriendsOnStart(): Promise; /** * Retrieves the current UI mode. - * @returns {Promise} - A Promise that resolves to the current UI mode. + * @returns A Promise that resolves to the current UI mode. */ GetUIMode(): Promise; @@ -61,41 +61,40 @@ export interface WebChat { /** * Registers a callback function to be called when the computer's active state changes. - * @param {function} callback - The callback function to be called. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @param callback The callback function to be called. + * @returns An object that can be used to unregister the callback. * @todo Changes to 2 after 10 seconds? * @todo Does not affect the keyboard? */ RegisterForComputerActiveStateChange( callback: (state: ComputerActiveState, time: number) => void, - ): Unregisterable | any; + ): Unregisterable; /** * @todo WebChat.ShowFriendChatDialog does this. */ - RegisterForFriendPostMessage(callback: (data: FriendChatDialogData) => void): Unregisterable | any; + RegisterForFriendPostMessage(callback: (data: FriendChatDialogData) => void): Unregisterable; /** * To unregister, use {@link UnregisterForMouseXButtonDown}. - * @returns {void} */ RegisterForMouseXButtonDown(callback: any): void; /** * Registers a callback function to be called when the push-to-talk state changes. - * @param {function} callback - The callback function to be called. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @param callback The callback function to be called. + * @returns An object that can be used to unregister the callback. */ - RegisterForPushToTalkStateChange(callback: (state: boolean) => void): Unregisterable | any; + RegisterForPushToTalkStateChange(callback: (state: boolean) => void): Unregisterable; /** * Registers a callback function to be called when the UI mode is changed. - * @param {function} callback - The callback function to be called. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @param callback The callback function to be called. + * @returns An object that can be used to unregister the callback. */ - RegisterForUIModeChange(callback: (mode: UIMode) => void): Unregisterable | any; + RegisterForUIModeChange(callback: (mode: UIMode) => void): Unregisterable; - RegisterOverlayChatBrowserInfoChanged(callback: any): Unregisterable | any; + RegisterOverlayChatBrowserInfoChanged(callback: any): Unregisterable; SetActiveClanChatIDs(clanChatIds: any[]): any; @@ -156,4 +155,4 @@ export interface PushToTalkInfo { vkHotKey: number; /** Push-to-talk hotkey name. */ strKeyName: string; -} \ No newline at end of file +} diff --git a/src/deck-components/steam-client/WebUITransport.ts b/src/deck-components/steam-client/WebUITransport.ts index ab31d7a1..79289f4b 100644 --- a/src/deck-components/steam-client/WebUITransport.ts +++ b/src/deck-components/steam-client/WebUITransport.ts @@ -18,4 +18,4 @@ export interface TransportInfo { authKeySteamUI: string; portClientdll: number; portSteamUI: number; -} \ No newline at end of file +} diff --git a/src/deck-components/steam-client/Window.ts b/src/deck-components/steam-client/Window.ts index ca488de0..b7aaea62 100644 --- a/src/deck-components/steam-client/Window.ts +++ b/src/deck-components/steam-client/Window.ts @@ -25,7 +25,6 @@ export interface Window { /** * Flashes the window in the taskbar. - * @returns {void} */ FlashWindow(): void; @@ -48,7 +47,6 @@ export interface Window { /** * Hides the window. - * @returns {void} */ HideWindow(): void; @@ -66,35 +64,31 @@ export interface Window { /** * Minimizes the window. - * @returns {void} */ Minimize(): void; /** * Moves the window to given coordinates. - * @param {number} x - Window X position. - * @param {number} y - Window Y position. - * @param {number | undefined} dpi - Screen DPI. - * @returns {void} + * @param x Window X position. + * @param y Window Y position. + * @param dpi Screen DPI. */ MoveTo(x: number, y: number, dpi: number | undefined): void; /** * Moves the window to a given location. - * @param {string} location - Window location. - * @param {number | undefined} offset - X/Y offset. - * @returns {void} + * @param location Window location. + * @param offset X/Y offset. */ MoveToLocation(location: WindowLocation, offset: number | undefined): void; /** * Moves the window relatively to given details. - * @param {string} details - Window restore details string from {@link GetWindowRestoreDetails}. - * @param {number} x - Window X position. - * @param {number} y - Window Y position. - * @param {number} width - Window width. - * @param {number} height - Window height. - * @returns {void} + * @param details Window restore details string from {@link GetWindowRestoreDetails}. + * @param x Window X position. + * @param y Window Y position. + * @param width Window width. + * @param height Window height. * * @example * Move the window to bottom right by 50 pixels: @@ -114,17 +108,15 @@ export interface Window { /** * Resizes the window to given dimension. * The window has to be created with the resizable flag. - * @param {number} width - Window width. - * @param {number} height - Window height. - * @param {boolean | number} applyBrowserScaleOrDPIValue - * @returns {void} + * @param width Window width. + * @param height Window height. + * @param applyBrowserScaleOrDPIValue */ ResizeTo(width: number, height: number, applyBrowserScaleOrDPIValue: boolean | number): void; /** * Moves the window to given details. - * @param {string} details - Window details string from `Window.GetWindowRestoreDetails`. - * @returns {void} + * @param details Window details string from `Window.GetWindowRestoreDetails`. */ RestoreWindowSizeAndPosition(details: string): void; @@ -134,8 +126,7 @@ export interface Window { /** * Makes the window hide, but not close on pressing the close button. - * @param {boolean} value - Hide on close? - * @returns {void} + * @param value Hide on close? */ SetHideOnClose(value: boolean): void; @@ -145,17 +136,15 @@ export interface Window { /** * Sets the window's max size. - * @param {number} width - Window's max width. - * @param {number} height - Window's max height. - * @returns {void} + * @param width Window's max width. + * @param height Window's max height. */ SetMaxSize(width: number, height: number): void; /** * Sets the window's min size. - * @param {number} width - Window's max width. - * @param {number} height - Window's max height. - * @returns {void} + * @param width Window's max width. + * @param height Window's max height. */ SetMinSize(width: number, height: number): void; @@ -164,40 +153,34 @@ export interface Window { /** * Sets the window's resize grip size. * The window has to be created with the resizable flag for this to take any effect. - * @param {number} width - Resize grip width. - * @param {number} height - Resize grip height. - * @returns {void} + * @param width Resize grip width. + * @param height Resize grip height. */ SetResizeGrip(width: number, height: number): void; /** * Set the window's icon. - * @param {WindowIcon} icon - The window icon to be used. - * @returns {void} + * @param icon The window icon to be used. */ SetWindowIcon(icon: WindowIcon): void; /** * Shows the window. - * @returns {void} */ ShowWindow(): void; /** * Stops the window's taskbar flashing. - * @returns {void} */ StopFlashWindow(): void; /** * Toggles the window's fullscreen state. - * @returns {void} */ ToggleFullscreen(): void; /** * Toggles the window's maximized state. - * @returns {void} */ ToggleMaximize(): void; } diff --git a/src/deck-components/steam-client/browser-view/BrowserViewPopup.ts b/src/deck-components/steam-client/browser-view/BrowserViewPopup.ts index 91c64f1c..4775450b 100644 --- a/src/deck-components/steam-client/browser-view/BrowserViewPopup.ts +++ b/src/deck-components/steam-client/browser-view/BrowserViewPopup.ts @@ -3,23 +3,22 @@ import {TouchGestureType} from "../Browser"; export interface BrowserViewPopup { /** * Blur the popup. - * @param {boolean} enabled - Is the blur enabled? - * @param {boolean} backgroundColor - * @param {boolean} blur - * @returns {void} + * @param enabled Is the blur enabled? + * @param backgroundColor + * @param blur * @todo backgroundColor is a bool? Whatever that means */ AddGlass(enabled: boolean, backgroundColor: boolean, blur: boolean): void; /** * Indicates whether you can go backward in history or not. - * @returns {boolean} true if you can go backward in history, false otherwise. + * @returns true if you can go backward in history, false otherwise. */ CanGoBackward(): boolean; /** * Indicates whether you can go forward in history or not. - * @returns {boolean} true if you can go forward in history, false otherwise. + * @returns true if you can go forward in history, false otherwise. */ CanGoForward(): boolean; @@ -30,28 +29,25 @@ export interface BrowserViewPopup { /** * Find a string in the page. - * @param {string} input - The string to find. - * @param {boolean} param1 - Additional parameter (exact usage may vary). - * @param {boolean} previous - `true` for previous match, `false` for next match. - * @returns {void} + * @param input The string to find. + * @param param1 Additional parameter (exact usage may vary). + * @param previous `true` for previous match, `false` for next match. */ FindInPage(input: string, param1: boolean, previous: boolean): void; /** * Get the current popup position. - * @returns {BrowserViewBounds} The window position. + * @returns The window position. */ GetBounds(): BrowserViewBounds; /** * Go back in history. - * @returns {void} */ GoBack(): void; /** * Go forward in history. - * @returns {void} */ GoForward(): void; @@ -62,8 +58,7 @@ export interface BrowserViewPopup { /** * Load the specified URL. - * @param {string} url - The URL to go to. - * @returns {void} + * @param url The URL to go to. */ LoadURL(url: string): void; @@ -71,7 +66,6 @@ export interface BrowserViewPopup { /** * Paste the current clipboard selection. - * @returns {void} */ Paste(): void; @@ -79,38 +73,33 @@ export interface BrowserViewPopup { /** * Reload the page. - * @returns {void} */ Reload(): void; /** * Load the specified URL, but don't save history. - * @param {string} url - The URL to go to. - * @returns {void} + * @param url The URL to go to. */ ReplaceURL(url: string): void; /** * Define blocked protocols, like https, etc. * @param protocols The protocols to block, separated by a semicolon. - * @returns {void} */ SetBlockedProtocols(protocols: string): void; /** * Sets the browser window position. - * @param {number} x - Browser window X position. - * @param {number} y - Browser window Y position. - * @param {number} width - Browser window width. - * @param {number} height - Browser window height. - * @returns {void} + * @param x Browser window X position. + * @param y Browser window Y position. + * @param width Browser window width. + * @param height Browser window height. */ SetBounds(x: number, y: number, width: number, height: number): void; /** * Sets the browser window focus state. - * @param {boolean} value - Is the window focused? - * @returns {void} + * @param value Is the window focused? */ SetFocus(value: boolean): void; @@ -118,19 +107,17 @@ export interface BrowserViewPopup { /** * Registers a callback to be called when a context menu is shown. - * @param {function} callback - The callback function to be called. + * @param callback The callback function to be called. */ SetShowContextMenuCallback(callback: (data: BrowserViewContextMenu) => void): void; /** * Registers a callback to be called when a steam:// protocol URL is loaded. - * @returns {void} */ SetSteamURLCallback(callback: (steamURL: string) => void): void; /** * Raises the browser window. - * @returns {void} */ SetTopWindow(): void; @@ -145,23 +132,20 @@ export interface BrowserViewPopup { /** * Stop the "find in page" function. - * @returns {void} */ StopFindInPage(): void; /** * Stop listening for an event. - * @param {BrowserViewEvent} event - The event to stop listening to. - * @param {function} callback - The callback function to be called. - * @returns {void} + * @param event The event to stop listening to. + * @param callback The callback function to be called. */ off(event: BrowserViewEvent, callback: (args: any) => void): void; /** * Start listening for an event. - * @param {BrowserViewEvent} event - The event to start listening to. - * @param {function} callback - The callback function to be called. - * @returns {void} + * @param event The event to start listening to. + * @param callback The callback function to be called. */ on(event: BrowserViewEvent, callback: (args: any) => void): void; @@ -386,4 +370,4 @@ export interface BrowserViewPageSecurity { certName: string; issuerName: string; nCertBits: number; -} \ No newline at end of file +} diff --git a/src/deck-components/steam-client/browser-view/index.ts b/src/deck-components/steam-client/browser-view/index.ts index acc8b2fa..0af2a749 100644 --- a/src/deck-components/steam-client/browser-view/index.ts +++ b/src/deck-components/steam-client/browser-view/index.ts @@ -24,4 +24,4 @@ export interface BrowserViewInit { strUserAgentIdentifier?: string; strUserAgentOverride?: string; strVROverlayKey?: string; -} \ No newline at end of file +} diff --git a/src/deck-components/steam-client/index.ts b/src/deck-components/steam-client/index.ts index 8ee1ec66..56cbce9f 100644 --- a/src/deck-components/steam-client/index.ts +++ b/src/deck-components/steam-client/index.ts @@ -612,4 +612,4 @@ export enum ParentalFeature { SiteLicense = 13, KioskMode = 14, Max = 15, -} \ No newline at end of file +} diff --git a/src/deck-components/steam-client/system/Audio.ts b/src/deck-components/steam-client/system/Audio.ts index 5a5a0dea..f9031967 100644 --- a/src/deck-components/steam-client/system/Audio.ts +++ b/src/deck-components/steam-client/system/Audio.ts @@ -6,96 +6,96 @@ import {OperationResponse, Unregisterable} from "../index"; export interface Audio { /** * Clears the default device override for a specified audio type. - * @param {number} audioType - The audio type (0 for input, 1 for output). - * @returns {Promise} - A Promise indicating the result of the operation. + * @param audioType The audio type (0 for input, 1 for output). + * @returns A Promise indicating the result of the operation. */ ClearDefaultDeviceOverride(audioType: number): Promise; /** * Retrieves information about audio applications. - * @returns {Promise} - A Promise that resolves to information about audio applications. + * @returns A Promise that resolves to information about audio applications. */ GetApps(): Promise; /** * Retrieves information about audio devices. - * @returns {Promise} - A Promise that resolves to information about audio devices. + * @returns A Promise that resolves to information about audio devices. */ GetDevices(): Promise; /** * Registers a callback to be called when a new audio application is added. - * @param {function} callback - The callback function to be called. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @param callback The callback function to be called. + * @returns An object that can be used to unregister the callback. */ - RegisterForAppAdded(callback: (appAudioAdded: ApplicationAudio) => void): Unregisterable | any; + RegisterForAppAdded(callback: (appAudioAdded: ApplicationAudio) => void): Unregisterable; /** * Registers a callback to be called when an audio application is removed. - * @param {function} callback - The callback function to be called. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @param callback The callback function to be called. + * @returns An object that can be used to unregister the callback. */ - RegisterForAppRemoved(callback: (appAudioId: number) => void): Unregisterable | any; + RegisterForAppRemoved(callback: (appAudioId: number) => void): Unregisterable; /** * Registers a callback to be called when the volume of an audio application changes. - * @param {function} callback - The callback function to be called. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @param callback The callback function to be called. + * @returns An object that can be used to unregister the callback. */ - RegisterForAppVolumeChanged(callback: (appAudioId: number, volume: number) => void): Unregisterable | any; + RegisterForAppVolumeChanged(callback: (appAudioId: number, volume: number) => void): Unregisterable; /** * Registers a callback to be called when a new audio device is added. - * @param {function} callback - The callback function to be called. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @param callback The callback function to be called. + * @returns An object that can be used to unregister the callback. */ - RegisterForDeviceAdded(callback: (audioDevice: Device) => void): Unregisterable | any; + RegisterForDeviceAdded(callback: (audioDevice: Device) => void): Unregisterable; /** * Registers a callback to be called when an audio device is removed. - * @param {function} callback - The callback function to be called. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @param callback The callback function to be called. + * @returns An object that can be used to unregister the callback. */ - RegisterForDeviceRemoved(callback: (audioDeviceId: number) => void): Unregisterable | any; + RegisterForDeviceRemoved(callback: (audioDeviceId: number) => void): Unregisterable; /** * Registers a callback to be called when the volume of an audio device changes. - * @param {function} callback - The callback function to be called. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @param callback The callback function to be called. + * @returns An object that can be used to unregister the callback. */ - RegisterForDeviceVolumeChanged(callback: (audioDeviceId: number, audioType: number, volume: number) => void): Unregisterable | any; + RegisterForDeviceVolumeChanged(callback: (audioDeviceId: number, audioType: number, volume: number) => void): Unregisterable; - RegisterForServiceConnectionStateChanges(callback: (param0: any) => void): Unregisterable | any; + RegisterForServiceConnectionStateChanges(callback: (param0: any) => void): Unregisterable; /** * Registers a callback to be called when volume buttons are pressed. - * @param {function} callback - The callback function to be called. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @param callback The callback function to be called. + * @returns An object that can be used to unregister the callback. */ - RegisterForVolumeButtonPressed(callback: (volumeUpPressed: boolean) => void): Unregisterable | any; + RegisterForVolumeButtonPressed(callback: (volumeUpPressed: boolean) => void): Unregisterable; /** * Sets the volume of an audio application. - * @param {number} appAudioId - The ID of the audio application. - * @param {number} volume - The volume level (floating point value between 0 and 1). - * @returns {Promise} - A Promise indicating the result of the operation. + * @param appAudioId The ID of the audio application. + * @param volume The volume level (floating point value between 0 and 1). + * @returns A Promise indicating the result of the operation. */ SetAppVolume(appAudioId: number, volume: number): Promise; /** * Sets the default device override for a specified audio type. - * @param {number} audioDeviceId - The ID of the audio device. - * @param {number} audioType - The audio type (0 for input, 1 for output). - * @returns {Promise} - A Promise indicating the result of the operation. + * @param audioDeviceId The ID of the audio device. + * @param audioType The audio type (0 for input, 1 for output). + * @returns A Promise indicating the result of the operation. */ SetDefaultDeviceOverride(audioDeviceId: number, audioType: number): Promise; /** * Sets the volume of an audio device. - * @param {number} audioDeviceId - The ID of the audio device. - * @param {number} audioType - The audio type (0 for input, 1 for output). - * @param {number} volume - The volume level (floating point value between 0 and 1). - * @returns {Promise} - A Promise indicating the result of the operation. + * @param audioDeviceId The ID of the audio device. + * @param audioType The audio type (0 for input, 1 for output). + * @param volume The volume level (floating point value between 0 and 1). + * @returns A Promise indicating the result of the operation. */ SetDeviceVolume(audioDeviceId: number, audioType: number, volume: number): Promise; } @@ -203,4 +203,4 @@ export interface Device { * The volume level of the audio input device (floating point value between 0 and 1). */ flInputVolume: number; -} \ No newline at end of file +} diff --git a/src/deck-components/steam-client/system/AudioDevice.ts b/src/deck-components/steam-client/system/AudioDevice.ts index f9b8d78b..8aadef12 100644 --- a/src/deck-components/steam-client/system/AudioDevice.ts +++ b/src/deck-components/steam-client/system/AudioDevice.ts @@ -3,9 +3,9 @@ import {JsPbMessage, Unregisterable} from "../index"; export interface AudioDevice { /** * If `data` is deserialized, returns {@link MsgSystemAudioManagerState}. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @returns An object that can be used to unregister the callback. */ - RegisterForStateChanges(callback: (data: ArrayBuffer) => void): Unregisterable | any; + RegisterForStateChanges(callback: (data: ArrayBuffer) => void): Unregisterable; UpdateSomething(param0: any): any; // e.UpdateSomething(t.serializeBase64String()) } @@ -113,4 +113,4 @@ export enum SystemAudioChannel { FrontCenter = 7, Unknown = 8, Mono = 9, -} \ No newline at end of file +} diff --git a/src/deck-components/steam-client/system/Bluetooth.ts b/src/deck-components/steam-client/system/Bluetooth.ts index f17d4bec..35d885cd 100644 --- a/src/deck-components/steam-client/system/Bluetooth.ts +++ b/src/deck-components/steam-client/system/Bluetooth.ts @@ -6,63 +6,63 @@ import {OperationResponse, Unregisterable} from "../index"; export interface Bluetooth { /** * Cancels an ongoing pairing request with a Bluetooth device. - * @param {number} adapterId - The ID of the Bluetooth adapter. - * @param {number} deviceId - The ID of the Bluetooth device to cancel pairing with. - * @returns {Promise} - A Promise that resolves with the result of the cancellation. + * @param adapterId The ID of the Bluetooth adapter. + * @param deviceId The ID of the Bluetooth device to cancel pairing with. + * @returns A Promise that resolves with the result of the cancellation. */ CancelPairing(adapterId: number, deviceId: number): Promise; /** * Connects to a paired Bluetooth device using the specified adapter. - * @param {number} adapterId - The ID of the Bluetooth adapter. - * @param {number} deviceId - The ID of the paired Bluetooth device to connect to. - * @returns {Promise} - A Promise that resolves with the result of the connection attempt. + * @param adapterId The ID of the Bluetooth adapter. + * @param deviceId The ID of the paired Bluetooth device to connect to. + * @returns A Promise that resolves with the result of the connection attempt. */ Connect(adapterId: number, deviceId: number): Promise; /** * Disconnects from a currently connected Bluetooth device using the specified adapter. - * @param {number} adapterId - The ID of the Bluetooth adapter. - * @param {number} deviceId - The ID of the connected Bluetooth device to disconnect from. - * @returns {Promise} - A Promise that resolves with the result of the disconnection. + * @param adapterId The ID of the Bluetooth adapter. + * @param deviceId The ID of the connected Bluetooth device to disconnect from. + * @returns A Promise that resolves with the result of the disconnection. */ Disconnect(adapterId: number, deviceId: number): Promise; /** * Initiates pairing with a Bluetooth device using the specified adapter. - * @param {number} adapterId - The ID of the Bluetooth adapter. - * @param {number} deviceId - The ID of the Bluetooth device to initiate pairing with. - * @returns {Promise} - A Promise that resolves with the result of the pairing attempt. + * @param adapterId The ID of the Bluetooth adapter. + * @param deviceId The ID of the Bluetooth device to initiate pairing with. + * @returns A Promise that resolves with the result of the pairing attempt. */ Pair(adapterId: number, deviceId: number): Promise; /** * Registers a callback function to be called when the Bluetooth state changes. - * @param {function} callback - The callback function to be called. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @param callback The callback function to be called. + * @returns An object that can be used to unregister the callback. */ - RegisterForStateChanges(callback: (bluetoothStateChange: BluetoothStateChange) => void): Unregisterable | any; + RegisterForStateChanges(callback: (bluetoothStateChange: BluetoothStateChange) => void): Unregisterable; /** * Sets whether the Bluetooth adapter should be in discovering mode. - * @param {number} adapterId - The ID of the Bluetooth adapter. - * @param {boolean} value - `true` to enable discovering mode, `false` to disable it. - * @returns {Promise} - A Promise that resolves with the result of the operation. + * @param adapterId The ID of the Bluetooth adapter. + * @param value `true` to enable discovering mode, `false` to disable it. + * @returns A Promise that resolves with the result of the operation. */ SetAdapterDiscovering(adapterId: number, value: boolean): Promise; /** * Enables or disables Bluetooth functionality. - * @param {boolean} bluetooth - `true` to enable Bluetooth, `false` to disable it. - * @returns {Promise} - A Promise that resolves with the result of the operation. + * @param bluetooth `true` to enable Bluetooth, `false` to disable it. + * @returns A Promise that resolves with the result of the operation. */ SetEnabled(bluetooth: boolean): Promise; /** * Unpairs a Bluetooth device from the adapter. - * @param {number} adapterId - The ID of the Bluetooth adapter. - * @param {number} deviceId - The ID of the Bluetooth device to unpair with. - * @returns {Promise} - A Promise that resolves with the result of the unpairing request. + * @param adapterId The ID of the Bluetooth adapter. + * @param deviceId The ID of the Bluetooth device to unpair with. + * @returns A Promise that resolves with the result of the unpairing request. */ UnPair(adapterId: number, deviceId: number): Promise; } @@ -175,4 +175,4 @@ export enum BluetoothDeviceType { Joystick = 9, Gamepad = 10, Keyboard = 11, -} \ No newline at end of file +} diff --git a/src/deck-components/steam-client/system/Devkit.ts b/src/deck-components/steam-client/system/Devkit.ts index f29f2f1a..242643d7 100644 --- a/src/deck-components/steam-client/system/Devkit.ts +++ b/src/deck-components/steam-client/system/Devkit.ts @@ -3,9 +3,9 @@ import {Unregisterable} from "../index"; export interface Devkit { DeveloperModeChanged(state: boolean): any; - RegisterForPairingPrompt(callback: (param0: any) => any): Unregisterable | any; + RegisterForPairingPrompt(callback: (param0: any) => any): Unregisterable; RespondToPairingPrompt(param0: any, param1: any): any; SetPairing(param0: any): any; -} \ No newline at end of file +} diff --git a/src/deck-components/steam-client/system/Display.ts b/src/deck-components/steam-client/system/Display.ts index 886dbf82..3272292c 100644 --- a/src/deck-components/steam-client/system/Display.ts +++ b/src/deck-components/steam-client/system/Display.ts @@ -3,7 +3,7 @@ import {Unregisterable} from "../index"; export interface Display { EnableUnderscan(param0: boolean): any; - RegisterForBrightnessChanges(callback: (brightnessChanges: BrightnessChange) => void): Unregisterable | any; + RegisterForBrightnessChanges(callback: (brightnessChanges: BrightnessChange) => void): Unregisterable; SetBrightness(brightness: number): any; diff --git a/src/deck-components/steam-client/system/DisplayManager.ts b/src/deck-components/steam-client/system/DisplayManager.ts index 874a072d..dd6d49f9 100644 --- a/src/deck-components/steam-client/system/DisplayManager.ts +++ b/src/deck-components/steam-client/system/DisplayManager.ts @@ -6,11 +6,11 @@ export interface DisplayManager { GetState: any; - RegisterForStateChanges(callback: () => void): Unregisterable | any; + RegisterForStateChanges(callback: () => void): Unregisterable; SetCompatibilityMode(displayId: any): any; SetGamescopeInternalResolution(width: number, height: number): any; SetMode(base64: string): any; // -} \ No newline at end of file +} diff --git a/src/deck-components/steam-client/system/Dock.ts b/src/deck-components/steam-client/system/Dock.ts index c79e3cf8..cc683ce7 100644 --- a/src/deck-components/steam-client/system/Dock.ts +++ b/src/deck-components/steam-client/system/Dock.ts @@ -7,9 +7,9 @@ export interface Dock { /** * If `data` is deserialized, returns {@link MsgSystemDockState}. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @returns An object that can be used to unregister the callback. */ - RegisterForStateChanges(callback: (data: ArrayBuffer) => void): Unregisterable | any; + RegisterForStateChanges(callback: (data: ArrayBuffer) => void): Unregisterable; UpdateFirmware(base64String: string): any; // serialize base64 string } diff --git a/src/deck-components/steam-client/system/Perf.ts b/src/deck-components/steam-client/system/Perf.ts index afcabff4..594e77c1 100644 --- a/src/deck-components/steam-client/system/Perf.ts +++ b/src/deck-components/steam-client/system/Perf.ts @@ -4,15 +4,15 @@ import {JsPbMessage, Unregisterable} from "../index"; export interface Perf { /** * If `data` is deserialized, returns {@link MsgSystemPerfDiagnosticInfo}. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @returns An object that can be used to unregister the callback. */ - RegisterForDiagnosticInfoChanges(callback: (data: ArrayBuffer) => void): Unregisterable | any; + RegisterForDiagnosticInfoChanges(callback: (data: ArrayBuffer) => void): Unregisterable; /** * If `data` is deserialized, returns {@link MsgSystemPerfState}. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @returns An object that can be used to unregister the callback. */ - RegisterForStateChanges(callback: (data: ArrayBuffer) => void): Unregisterable | any; + RegisterForStateChanges(callback: (data: ArrayBuffer) => void): Unregisterable; UpdateSettings(base64: string): any; // serialize } diff --git a/src/deck-components/steam-client/system/Report.ts b/src/deck-components/steam-client/system/Report.ts index ee1f5dda..bb51c7bf 100644 --- a/src/deck-components/steam-client/system/Report.ts +++ b/src/deck-components/steam-client/system/Report.ts @@ -37,4 +37,4 @@ export interface MsgGenerateSystemReportReply extends JsPbMessage { report_id(): string | undefined; set_report_id(param0: any): any; -} \ No newline at end of file +} diff --git a/src/deck-components/steam-client/system/UI.ts b/src/deck-components/steam-client/system/UI.ts index 84d4d492..ea4c1fde 100644 --- a/src/deck-components/steam-client/system/UI.ts +++ b/src/deck-components/steam-client/system/UI.ts @@ -5,13 +5,13 @@ export interface UI { GetGameWindowsInfo(appId: number, windowIds: number[]): Promise; - RegisterForFocusChangeEvents(callback: (event: FocusChangeEvent) => void): Unregisterable | any; + RegisterForFocusChangeEvents(callback: (event: FocusChangeEvent) => void): Unregisterable; // appId is 0 if unknown app is focused - RegisterForOverlayGameWindowFocusChanged(callback: (appId: number, param1: number) => void): Unregisterable | any; + RegisterForOverlayGameWindowFocusChanged(callback: (appId: number, param1: number) => void): Unregisterable; //event.eKey, event.nControllerIndex - RegisterForSystemKeyEvents(callback: (event: any) => void): Unregisterable | any; // eKey + RegisterForSystemKeyEvents(callback: (event: any) => void): Unregisterable; // eKey } export interface FocusChangeEvent { diff --git a/src/deck-components/steam-client/system/index.ts b/src/deck-components/steam-client/system/index.ts index 3acf1f05..78687d20 100644 --- a/src/deck-components/steam-client/system/index.ts +++ b/src/deck-components/steam-client/system/index.ts @@ -66,15 +66,14 @@ export interface System { /** * Open a dialog for choosing a file. - * @param {FileDialog} prefs - Dialog preferences. - * @returns {Promise} A Promise that resolves to the selected file name. + * @param prefs Dialog preferences. + * @returns A Promise that resolves to the selected file name. * @throws Throws if no file was selected. */ OpenFileDialog(prefs: FileDialog): Promise; /** * Open a URL in the default web browser. - * @returns {void} */ OpenInSystemBrowser(url: string): void; @@ -85,20 +84,20 @@ export interface System { RebootToFactoryTestImage(param0: any): any; - RegisterForAirplaneModeChanges(callback: (airplaneModeChange: AirplaneModeChange) => void): Unregisterable | any; + RegisterForAirplaneModeChanges(callback: (airplaneModeChange: AirplaneModeChange) => void): Unregisterable; - RegisterForBatteryStateChanges(callback: (batteryStateChange: BatteryStateChange) => void): Unregisterable | any; + RegisterForBatteryStateChanges(callback: (batteryStateChange: BatteryStateChange) => void): Unregisterable; - RegisterForFormatStorageProgress(callback: () => void): Unregisterable | any; // {"flProgress":0,"rtEstimatedCompletionTime":0,"eStage":1} + RegisterForFormatStorageProgress(callback: () => void): Unregisterable; // {"flProgress":0,"rtEstimatedCompletionTime":0,"eStage":1} - RegisterForOnResumeFromSuspend(callback: () => void): Unregisterable | any; + RegisterForOnResumeFromSuspend(callback: () => void): Unregisterable; - RegisterForOnSuspendRequest(callback: () => void): Unregisterable | any; + RegisterForOnSuspendRequest(callback: () => void): Unregisterable; /** - * @returns {Promise} A Promise that resolves to a ProtoBuf message. If deserialized, returns {@link MsgSystemManagerSettings}. + * @returns A Promise that resolves to a ProtoBuf message. If deserialized, returns {@link MsgSystemManagerSettings}. */ - RegisterForSettingsChanges(callback: (data: ArrayBuffer) => void): Unregisterable | any; + RegisterForSettingsChanges(callback: (data: ArrayBuffer) => void): Unregisterable; Report: Report; @@ -366,4 +365,4 @@ export interface MsgSystemManagerSettings extends JsPbMessage { is_fan_control_available(): boolean; is_wifi_powersave_enabled(): boolean; -} \ No newline at end of file +} diff --git a/src/deck-components/steam-client/system/network/Device.ts b/src/deck-components/steam-client/system/network/Device.ts index d65240ad..a0e84fb3 100644 --- a/src/deck-components/steam-client/system/network/Device.ts +++ b/src/deck-components/steam-client/system/network/Device.ts @@ -9,4 +9,4 @@ export interface WirelessNetwork { Forget(deviceId: any, deviceWapId: any): any; SetAutoconnect(deviceId: any, deviceWapId: any, autoConnect: boolean): any; -} \ No newline at end of file +} diff --git a/src/deck-components/steam-client/system/network/index.ts b/src/deck-components/steam-client/system/network/index.ts index f395cbf6..dcddd073 100644 --- a/src/deck-components/steam-client/system/network/index.ts +++ b/src/deck-components/steam-client/system/network/index.ts @@ -12,22 +12,22 @@ export interface Network { GetProxyInfo(): Promise; // data.nAppID, data.serializedMsg - RegisterForAppSummaryUpdate(callback: (data: any) => any): Unregisterable | any; + RegisterForAppSummaryUpdate(callback: (data: any) => any): Unregisterable; /** * @todo {@link GameNetworkingUI_ConnectionState}, unconfirmed */ - RegisterForConnectionStateUpdate: Unregisterable | any; + RegisterForConnectionStateUpdate: Unregisterable; RegisterForConnectivityTestChanges( callback: (connectivityTestChange: ConnectivityTestChange) => void, - ): Unregisterable | any; + ): Unregisterable; /** * If `data` is deserialized, returns {@link MsgNetworkDevicesData}. - * @returns {Unregisterable | any} - An object that can be used to unregister the callback. + * @returns An object that can be used to unregister the callback. */ - RegisterForDeviceChanges(callback: (data: ArrayBuffer) => void): Unregisterable | any; + RegisterForDeviceChanges(callback: (data: ArrayBuffer) => void): Unregisterable; SetFakeLocalSystemState(state: NetFakeLocalSystemState): void; @@ -192,4 +192,4 @@ export enum WirelessAPStrength { Ok = 2, Good = 3, Excellent = 4, -} \ No newline at end of file +}