Class Endpoint

An endpoint provides URLs for http and ws, based on configuration and defaults.

Index

Constructors

Properties

location options PROTO_FILE PROTO_HTTP PROTO_HTTPS PROTO_WS PROTO_WSS

Accessors

host httpScheme origin path pathname port wsScheme

Methods

getRestUrl getSearchParam getWebSocketUrl

Constructors

constructor

new Endpoint(options?: Endpoint.Options, location?: Endpoint.Location): Endpoint
Parameters
- options: Endpoint.Options = {}
- location: Endpoint.Location = self.location
Returns Endpoint
- Defined in packages/core/src/browser/endpoint.ts:29

Properties

`Protected` `Readonly`location

location: Endpoint.Location = self.location

`Protected` `Readonly`options

options: Endpoint.Options = {}

`Static` `Readonly`PROTO_FILE

PROTO_FILE: string = 'file:'

`Static` `Readonly`PROTO_HTTP

PROTO_HTTP: string = 'http:'

`Static` `Readonly`PROTO_HTTPS

PROTO_HTTPS: string = 'https:'

`Static` `Readonly`PROTO_WS

PROTO_WS: string = 'ws:'

`Static` `Readonly`PROTO_WSS

PROTO_WSS: string = 'wss:'

Accessors

host

get host(): string
Returns string
- Defined in packages/core/src/browser/endpoint.ts:55

httpScheme

get httpScheme(): string
The HTTP/HTTPS scheme of the endpoint, or the user defined one. See: Endpoint.Options.httpScheme.

Returns string
- Defined in packages/core/src/browser/endpoint.ts:97

origin

get origin(): string
Returns string
- Defined in packages/core/src/browser/endpoint.ts:65

`Protected`path

get path(): string
Returns string
- Defined in packages/core/src/browser/endpoint.ts:108

`Protected`pathname

get pathname(): string
Returns string
- Defined in packages/core/src/browser/endpoint.ts:42

`Protected`port

get port(): string
Returns string
- Defined in packages/core/src/browser/endpoint.ts:69

`Protected`wsScheme

get wsScheme(): string
Returns string
- Defined in packages/core/src/browser/endpoint.ts:86

Methods

getRestUrl

getRestUrl(): URI
Returns URI
- Defined in packages/core/src/browser/endpoint.ts:38

`Protected`getSearchParam

getSearchParam(name: string, defaultValue: string): string
Parameters
- name: string
- defaultValue: string
Returns string
- Defined in packages/core/src/browser/endpoint.ts:73

getWebSocketUrl

getWebSocketUrl(): URI
Returns URI
- Defined in packages/core/src/browser/endpoint.ts:34