royalroadl-api
Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Classes

Interfaces

Variables

Functions

Variables

Const HOST_NAME

HOST_NAME: "royalroadl.com" = "royalroadl.com"

Const PROTOCOL_PREFIX

PROTOCOL_PREFIX: "https://" = "https://"

Const PROTOCOL_PREFIX_INSECURE

PROTOCOL_PREFIX_INSECURE: "http://" = "http://"

Functions

getBaseAddress

  • getBaseAddress(insecure?: boolean): string

  • Parameters

    • Default value insecure: boolean = false

      HTTP / HTTPS

    Returns string

    • Base address with prepended protocol.

getUserAgent

  • getUserAgent(): string

  • Returns string

    • The user agent sent along with every request, containing name and version.

getVersion

  • getVersion(): any

  • Returns any

    • Version read from package.json.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc