Interface ConstructorOptions

An ITransport instance, if you need to specify a custom transport. If omitted, defaults to a WebSocketCMTransport instance for SteamClient platform types, and a WebApiTransport instance for all other platform types. In all likelihood, you don't need to use this.

If you specify a custom transport, then you are responsible for handling proxy or agent usage in your transport.

A string containing the local IP address you want to use. For example, 11.22.33.44. Cannot be used alongside socksProxy, httpProxy, or agent.

A string containing a URI for a SOCKS proxy. For example, socks5://user:pass@1.2.3.4:1080. Cannot be used alongside localAddress, httpProxy, or agent.

A string containing a URI for an HTTP proxy. For example, http://user:pass@1.2.3.4:80. Cannot be used alongside localAddress, socksProxy, or agent.

An https.Agent instance to use for requests. If omitted, a new https.Agent will be created internally. Cannot be used alongside localAddress, socksProxy, or httpProxy.

A string containing the user-agent you want to use when communicating with Steam. Only effective when using EAuthTokenPlatformType.WebBrowser.

Your Steam machine ID, used for SteamClient logins. Pass a Buffer containing your well-formed machine ID, pass true to have steam-session internally generate a machine ID using the same formula that steam-user uses by default, or pass false, null, or omit to not send a machine ID.

Your machine's friendly name. Only effective when using SteamClient. If omitted, a random machine name in the format DESKTOP-ABCDEFG will be generated automatically.