Class ISteamWebAPIUtilWrapper

Provides miscellaneous Web API related functionality through utility methods.

Hierarchy

ISteamWebAPIUtilWrapper

Index

Constructors

Properties

Methods

getServerInfo getSupportedAPIList

Constructors

constructor

new ISteamWebAPIUtilWrapper(http?): ISteamWebAPIUtilWrapper
Parameters
- http: WebApiClient = defaultWebApiClient
  
  HTTP client.
Returns ISteamWebAPIUtilWrapper
- Defined in wrapper/steamWebApiUtilWrapper.ts:18

Properties

`Private` `Readonly` webApiClient

webApiClient: WebApiClient

Methods

getServerInfo

getServerInfo(): Promise<ServerInfo>
Returns WebAPI server time & checks server status.

Returns Promise<ServerInfo>
- Defined in wrapper/steamWebApiUtilWrapper.ts:25

getSupportedAPIList

getSupportedAPIList(apiKey?): Promise<SupportedAPI>
Lists all available WebAPI interfaces.
Parameters
- Optional apiKey: string
  
  (Optional) Presence of a Steam WebAPI key will display all available methods & interfaces allowed for that key.
Returns Promise<SupportedAPI>
- Defined in wrapper/steamWebApiUtilWrapper.ts:35

Generated using TypeDoc