Interface RequestServiceConfig

The configuration options for the RequestService

Hierarchy

Properties

customServices? hostname? invalidSessionRetryConfig? password? pathname? port? protocol? username?

Properties

Optional customServices

customServices?: {
    sessionService?: SessionService;
}

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

Type declaration

  • Optional sessionService?: SessionService

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

    Default

    new SessionService()

Optional hostname

hostname?: string

The hostname to use for all requests

Default

'localhost'

Optional invalidSessionRetryConfig

invalidSessionRetryConfig?: Omit<InvalidSessionRetry, "count">

The configuration options for retrying a request if the session ID is invalid. By default, the request will be retried 3 times with a delay of 1 second before throwing an error.

Optional password

password?: string

The password to use for all requests

Default

'transmission'

Optional pathname

pathname?: string

The pathname to use for all requests

Default

'/transmission/rpc'

Optional port

port?: number

The port to use for all requests

Default

9091

Optional protocol

protocol?: "http" | "https"

The protocol to use for all requests

Default

'http'

Optional username

username?: string

The username to use for all requests

Default

'transmission'

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc