steamapi

---

steamapi / SteamAPIOptions

Interface: SteamAPIOptions

Defined in: SteamAPI.ts:32

Properties

baseActions?

optional baseActions: string

Defined in: SteamAPI.ts:73

URL to use for Steam action requests (only used for getLocations)

'https://steamcommunity.com/actions' by default

---

baseAPI?

optional baseAPI: string

Defined in: SteamAPI.ts:59

URL to use for Steam API requests

'https://api.steampowered.com' by default

---

baseStore?

optional baseStore: string

Defined in: SteamAPI.ts:66

URL to use for Steam Store API requests

'https://store.steampowered.com/api' by default

---

currency?

optional currency: Currency

Defined in: SteamAPI.ts:45

Default currency to use for the API when a currency is not explicitly provided

'us' by default

---

gameDetailCacheEnabled?

optional gameDetailCacheEnabled: boolean

Defined in: SteamAPI.ts:83

If inMemoryCacheEnabled is true, this decides whether to cache API requests for getGameDetails()

---

gameDetailCacheTTL?

optional gameDetailCacheTTL: number

Defined in: SteamAPI.ts:88

How long to cache getGameDetails() in milliseconds

---

headers?

optional headers: object

Defined in: SteamAPI.ts:52

Custom headers to send for all API requests

By default, User-Agent is "SteamAPI/ (https://www.npmjs.com/package/steamapi)"

Index Signature

[key: string]: string

---

inMemoryCacheEnabled?

optional inMemoryCacheEnabled: boolean

Defined in: SteamAPI.ts:78

Whether to use built-in in-memory caching for gameDetailCache and userResolveCache

---

language?

optional language: Language

Defined in: SteamAPI.ts:38

Default language to use for the API when a language is not explicitly provided

'english' by default

---

userResolveCacheEnabled?

optional userResolveCacheEnabled: boolean

Defined in: SteamAPI.ts:93

If inMemoryCacheEnabled is true, this decides whether to cache API requests for resolve()

---

userResolveCacheTTL?

optional userResolveCacheTTL: number

Defined in: SteamAPI.ts:98

How long to cache resolve() in milliseconds