Class Url

Hierarchy

Url

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Url(options: UrlOptions): Url

- Defined in packages/amagaki/src/url.ts:29
Creates Url instance. If host, scheme, and port are supplied options, those values will be used. By default, a reference to the pod's environment is used instead.

Parameters
- options: UrlOptions
Returns Url

Properties

Private Optional _host

_host?: string

Private Optional _port

_port?: string

Private Optional _scheme

_scheme?: string

Optional env

env?: Environment

path

path: string

Accessors

host

get host(): string

- Defined in packages/amagaki/src/url.ts:37
Returns string

port

get port(): string

- Defined in packages/amagaki/src/url.ts:45
Returns string

scheme

get scheme(): string

- Defined in packages/amagaki/src/url.ts:41
Returns string

Methods

toString

toString(): string

- Defined in packages/amagaki/src/url.ts:49
Returns string

Static relative

relative(other: string | Document, base: string | Document): string

- Defined in packages/amagaki/src/url.ts:64
Returns a URL relative to another URL. Accepts both Document objects (i.e. for returning the URL of one document relative to another) or URLs as strings. Accepts both full URLs or paths only.

Parameters
- other: string | Document
  
  The Document or URL being linked to.
- base: string | Document
  
  The Document or URL being linked from.
Returns string
The URL of other relative to base.

Generated using TypeDoc