Class URL

The URL interface is used to parse, construct, normalize, and encode URLs. It works by providing properties which allow you to easily read and modify the components of a URL.

You normally create a new URL object by specifying the URL as a string when calling its constructor, or by providing a relative URL and a base URL. You can then easily read the parsed components of the URL or make changes to the URL.

Hierarchy

  • URL

Implements

Constructors

constructor

Properties

hash host hostname href origin password pathname port protocol search username

Accessors

searchParams

Methods

toJSON toString canParse createObjectURL revokeObjectURL

Constructors

constructor

  • Constructs a new URL object by parsing the specified URL.

    Parameters

    • url: string | URL

      The input URL to be parsed.

    • Optional base: string | URL

      The base URL to use in case the input URL is a relative URL.

    Returns URL

Properties

hash

hash: string

host

host: string

hostname

hostname: string

href

href: string

Readonly origin

origin: string

password

password: string

pathname

pathname: string

port

port: string

protocol

protocol: string

search

search: string

username

username: string

Accessors

searchParams

  • get searchParams(): URLSearchParams

  • Returns URLSearchParams

Methods

toJSON

  • Returns a string containing the full URL. It is a synonym for the href property.

    Returns string

toString

  • Returns a string containing the full URL. It is a synonym for the href property, though it can't be used to modify the value.

    Returns string

Static canParse

  • Returns a boolean indicating whether or not an absolute URL, or a relative URL combined with a base URL, are parsable and valid.

    Parameters

    • url: string | URL

      The input URL to be parsed.

    • Optional base: string | URL

      The base URL to use in case the input URL is a relative URL.

    Returns void

    See

    https://developer.mozilla.org/docs/Web/API/URL/canParse_static

Static createObjectURL

  • Returns a string containing a URL which represents the provided Blob object.

    Parameters

    • obj: Blob

      The object for which an object URL is to be created.

    Returns string

Static revokeObjectURL

  • Revokes an object URL previously created using URL.createObjectURL().

    Parameters

    • url: string

      A string representing a URL that was created by calling URL.createObjectURL().

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc