Options
All
  • Public
  • Public/Protected
  • All
Menu

Class default

Hierarchy

  • default

Index

Constructors

Properties

Methods

Constructors

constructor

  • new default(httpRelayUrl?: URL, baseUrl?: URL): default

  • Creates HttpRelay object.

    Parameters

    • Optional httpRelayUrl: URL

      URL that points to HTTP Relay server. Default: https://demo.httprelay.io

    • Optional baseUrl: URL

      URL that will be used for generating route URLs. Default is taken from: document.baseURI

    Returns default

Properties

Readonly baseUrl

baseUrl: URL

Url or your HTML document

Readonly httpRelayUrl

httpRelayUrl: URL

HTTP Relay server URL

Methods

proxy

  • proxy(serverId?: string, wSecret?: string, path?: string, assetPathPrefix?: string): default

  • Creates HTTP Relay proxy communication method object.

    Parameters

    • Optional serverId: string

      proxy communication method server ID e.g. https://demo.httprelay.io/proxy/`myServerId`. Default: random string

    • Optional wSecret: string

      write permission secret. If set it will lock serverId and only with this secret client requests cen be handled. Makes sure that unauthorized handlers are not serving clients.

    • path: string = 'proxy/'

      custom path to proxy communication method endpoint. Default: proxy/

    • assetPathPrefix: string = ''

      asset path prefix.

    Returns default