Class DiscoveryService

Class used for discovering recommended servers.

Index

Constructors

Methods

findBestServer getAddressCandidates getRecommendedServerCandidates getRecommendedServers

Constructors

constructor

new DiscoveryService(jellyfin: Jellyfin): DiscoveryService
Parameters
- jellyfin: Jellyfin
Returns DiscoveryService
- Defined in discovery/discovery-service.ts:20

Methods

findBestServer

findBestServer(
servers: RecommendedServerInfo[],
): undefined | RecommendedServerInfo
Finds the best server from a list of recommended servers by score.
Parameters
- servers: RecommendedServerInfo[]
  A list of recommended servers.
Returns undefined | RecommendedServerInfo
The best scoring recommended server.
- Defined in discovery/discovery-service.ts:30

getAddressCandidates

getAddressCandidates(input: string): string[]
Gets a list of address candidates url strings from a provided url address string.
Parameters
- input: string
  A server url address string.
Returns string[]
A list of potential server addresses.
- Defined in discovery/discovery-service.ts:51

getRecommendedServerCandidates

getRecommendedServerCandidates(
input: string,
minimumScore?: RecommendedServerInfoScore,
): Promise<RecommendedServerInfo[]>
Gets a list of recommended server information from the address candidates of a potential server address.
Parameters
- input: string
  A potential server address.
- OptionalminimumScore: RecommendedServerInfoScore
  The minimum server score to include in the results.
Returns Promise<RecommendedServerInfo[]>
A list of RecommendedServerInfo from the address candidates.
- Defined in discovery/discovery-service.ts:76

getRecommendedServers

getRecommendedServers(
servers: string[],
minimumScore?: RecommendedServerInfoScore,
): Promise<RecommendedServerInfo[]>
Gets a list of recommended server information from a provided list of possible server addresses.
Parameters
- servers: string[]
  A list of possible server addresses.
- OptionalminimumScore: RecommendedServerInfoScore
  The minimum server score to include in the results.
Returns Promise<RecommendedServerInfo[]>
A list of RecommendedServerInfo from the possible server addresses.
- Defined in discovery/discovery-service.ts:62