Skip to content

Commit b8fc07b

Browse files
committed
Updated readme to mention machine ids
1 parent 38745ec commit b8fc07b

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -259,6 +259,10 @@ event is emitted.
259259
- `httpProxy` - A string containing a URI for an HTTP proxy. For example, `http://user:pass@1.2.3.4:80`
260260
- `socksProxy` - A string containing a URI for a SOCKS proxy. For example, `socks5://user:pass@1.2.3.4:1080`
261261
- `agent` - An `https.Agent` instance to use for requests. If omitted, a new `https.Agent` will be created internally.
262+
- `machineId` - Only applicable when using EAuthTokenPlatformType.SteamClient. Pass a `Buffer` containing a valid
263+
Steam machine ID. Pass `true` to have steam-session internally generate a machine ID using the [same format that
264+
steam-user uses](https://github.com/DoctorMcKay/node-steam-user#machineidformat). Pass `false`, `null`, or omit
265+
this property to not send a machine ID (not sending a machine ID may cause problems in the future).
262266

263267
You can only use one of `localAddress`, `httpProxy`, `socksProxy` or `agent` at the same time. If you try to use more
264268
than one of them, an Error will be thrown.

0 commit comments

Comments
 (0)