@j4ckofalltrades/steam-webapi-ts
Version:
Isomorphic Steam WebAPI wrapper in TypeScript
58 lines (57 loc) • 1.92 kB
TypeScript
import { WebApiClient } from "../core/webApiClient";
import { AppId } from "../core/steamWebApi";
export declare const GET_APP_LIST = "/ISteamApps/GetAppList/v2";
export declare const UP_TO_DATE_CHECK = "/ISteamApps/UpToDateCheck/v1";
/**
* @property apps A list of objects containing the title and app ID of each program available in the store.
*/
export type AppList = {
applist: {
apps: App[];
};
};
/**
* @property appid An integer containing the program's ID.
* @property name A string containing the program's publicly facing title.
*/
export type App = {
appid: AppId;
name: string;
};
/**
* @property success Boolean indicating if request was successful.
* @property up_to_date Boolean indicating if the given version number is the most current version.
* @property version_is_listable Boolean indicating if the given version can be listed in public changelogs.
* @property required_version (Optional) Integer of the most current version of the app available.
* @property message (Optional) A string giving the status message if applicable.
*/
export type UpToDateCheck = {
response: {
success: boolean;
up_to_date: boolean;
version_is_listable: boolean;
required_version?: number;
message?: string;
};
};
/**
* Used to access data about applications on Steam.
*/
export declare class ISteamAppsWrapper {
private readonly webApiClient;
/**
* @param webApiClient HTTP client.
*/
constructor(webApiClient?: WebApiClient);
/**
* Full list of every publicly facing program in the store/library.
*/
getAppList(): Promise<AppList>;
/**
* Check if a given app version is the most current available.
*
* @param appid AppID of game.
* @param version The installed version of the game.
*/
upToDateCheck(appid: AppId, version: string): Promise<UpToDateCheck>;
}