Steam WebLogin
💿 Installation
npm i steam-weblogin
📖 Usage
;; const community = ;community;
👥 Account
Properties
request
request: RequestAPI<any any any>
- requestretry (default) or request-promise instance
/* Example usage */const response = await accountrequest; accountrequest = ; // the best way to change the defaultsaccountrequest = accountrequest;
cookies
cookies: Cookies;
- Cookies instance
/* Example usage */accountcookies; accountcookies = jar;
Methods
constructor
cookies: Cookies | CookieArray
cookies
- logged in Steam cookies (sessionid, steamLoginSecure, ...), can be Cookies or CookieArray
/* Example usage */;const Account = default; // ES5 syntax const account = "steamLoginSecure=value" "sessionid=value" "steamCountry=value"; const account = cookies;
login
: LoginResponse
url
- any url that redirects to steam openid login page https://steamcommunity.com/openid/login?openid.mode=checkid_setup&openid.ns=..., like https://www.csgo500.com/steam/preauth (3d-party site)clone
- iftrue (default)
would useaccount.jar.clone()
, else would useaccount.jar
as a jar
/* Example usage */const response = await account;
rejects with LoginError if passed cookies are bad
LoginResponse
;
🍪 Cookies
Properties
jar
jar: CookieJar;
- CookieJar instance
/* Example usage */const str = cookiesjar; cookiesjar = ;
requestJar
readonly jar: request.CookieJar;
- RequestJar instance, changes when jar changes
/* Example usage */request;
Methods
constructor
cookies: CookieArray;
cookies
- logged in Steam cookies (sessionid, steamLoginSecure, ...), can be Cookies or CookieArray
; const cookies = "steamLoginSecure=value" "sessionid=value" "steamCountry=value"; const cookies = jar;
export
export: key: String value: String domain: String ...
- returns Cookie.Serialized[] (code)
clone
: Cookies
- returns Cookies' deep clone
CookieArray
;
;
❌ LoginError
Properties
message
message: String = "Must be logged in";
Methods
constructor
;
/* Example usage */; if error instanceof LoginError // do something
📝 License
Released under MIT license