import type {ITransport, ApiRequest, ApiResponse} from 'steam-session';

It's possible to define a custom transport to be used when interacting with the Steam login server. The default transport used to interact with the Steam login server is chosen depending on your provided EAuthTokenPlatformType.

For the SteamClient platform type, a WebSocketCMTransport will be used to communicate with a CM server using a WebSocket. For other platform types, a WebApiTransport will be used to interact with the Steam login server using api.steampowered.com.

You almost definitely don't need to do this. This is used by steam-user to communicate with the auth server over the same channel as the rest of its network communication. Unless this matches your use-case, I cannot think of any reason why you'd need to implement your own custom transport unless you for some reason need to tunnel requests over an entirely different network protocol. If you simply need to proxy requests, you should instead use httpProxy, socksProxy, or agent.

Hierarchy

  • ITransport

Methods

Methods

  • Sends a request to Steam.

    Parameters

    • request: ApiRequest

    Returns Promise<ApiResponse>

Generated using TypeDoc