Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TwitarrServer

Represents a remote Twitarr server.

Hierarchy

  • TwitarrServer

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Construct a new TwitarrServer object representing a remote server.

    example
    provide a pre-existing TwitarrAuthConfig for auth ```javascript const server = new TwitarrServer('Test', 'https://myserver/', auth); ```
    example
    provide a username and password for auth ```javascript const server = new TwitarrServer('Test', 'https://myserver/', 'admin', 'admin'); ```
    constructor

    Parameters

    • Optional name: string

      A name for the server suitable for display.

    • Optional url: string

      The URL to the server.

    • Optional auth: TwitarrAuthConfig | string

      A TwitarrAuthConfig, or the username to authorize as.

    • Optional password: string

      The password to authorize with if a username was supplied to the auth parameter.

    Returns TwitarrServer

Properties

auth

auth: TwitarrAuthConfig

The authorization configuration associated with the server.

id

id: string

A unique identifier for this server.

Optional name

name: string

An optional name associated with this server.

url

url: string

The base URL to the server.

Accessors

host

  • get host(): any

Methods

clone

resolveURL

  • resolveURL(forFragment?: string, withQuery?: any): any

  • Given a relative URL fragment, construct a URL for that fragment on the server.

    parm

    withQuery - Query parameters to be appended to the URL.

    Parameters

    • Optional forFragment: string

      The URL fragment to append to the server URL.

    • Optional withQuery: any

    Returns any

    A complete URL.

toString

  • toString(): string

Generated using TypeDoc