Type alias TransmissionClientConfig

TransmissionClientConfig: {
    customServices?: {
        requestService?: RequestService;
        sessionService?: SessionService;
    };
    hostname?: string;
    password?: string;
    pathname?: string;
    port?: number;
    protocol?: "http" | "https";
    username?: string;
}

The configuration options for the TransmissionClient

Type declaration

  • Optional customServices?: {
        requestService?: RequestService;
        sessionService?: SessionService;
    }

    Options for customizing the services used by the TransmissionClient. This is useful for testing as it allows you to mock the services.

    • Optional requestService?: RequestService

      The request service which is used to make requests to the Transmission RPC endpoint

      Default

      new RequestService()
    • Optional sessionService?: SessionService

      The session service which is used to obtain a session ID from the Transmission RPC endpoint

      Default

      new SessionService()
  • Optional hostname?: string

    The hostname to use for all requests

    Default

    'localhost'
  • Optional password?: string

    The password to use for all requests

    Default

    'transmission'
  • Optional pathname?: string

    The pathname to use for all requests

    Default

    '/transmission/rpc'
  • Optional port?: number

    The port to use for all requests

    Default

    9091
  • Optional protocol?: "http" | "https"

    The protocol to use for all requests

    Default

    'http'
  • Optional username?: string

    The username to use for all requests

    Default

    'transmission'

Settings

Member Visibility

Theme

Generated using TypeDoc