Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "url"

Index

Classes

Interfaces

Functions

Functions

domainToASCII

  • domainToASCII(domain: string): string

  • Parameters

    • domain: string

    Returns string

domainToUnicode

  • domainToUnicode(domain: string): string

  • Parameters

    • domain: string

    Returns string

fileURLToPath

  • fileURLToPath(url: string | URL): string

  • This function ensures the correct decodings of percent-encoded characters as well as ensuring a cross-platform valid absolute path string.

    Parameters

    • url: string | URL

      The file URL string or URL object to convert to a path.

    Returns string

format

  • Parameters

    Returns string

  • deprecated

    since v11.0.0 - Use the WHATWG URL API.

    Parameters

    Returns string

parse

  • parse(urlStr: string): UrlWithStringQuery
  • parse(urlStr: string, parseQueryString: false | undefined, slashesDenoteHost?: boolean): UrlWithStringQuery
  • parse(urlStr: string, parseQueryString: true, slashesDenoteHost?: boolean): UrlWithParsedQuery
  • parse(urlStr: string, parseQueryString: boolean, slashesDenoteHost?: boolean): Url
  • deprecated

    since v11.0.0 - Use the WHATWG URL API.

    Parameters

    • urlStr: string

    Returns UrlWithStringQuery

  • deprecated

    since v11.0.0 - Use the WHATWG URL API.

    Parameters

    • urlStr: string
    • parseQueryString: false | undefined
    • Optional slashesDenoteHost: boolean

    Returns UrlWithStringQuery

  • deprecated

    since v11.0.0 - Use the WHATWG URL API.

    Parameters

    • urlStr: string
    • parseQueryString: true
    • Optional slashesDenoteHost: boolean

    Returns UrlWithParsedQuery

  • deprecated

    since v11.0.0 - Use the WHATWG URL API.

    Parameters

    • urlStr: string
    • parseQueryString: boolean
    • Optional slashesDenoteHost: boolean

    Returns Url

pathToFileURL

  • pathToFileURL(url: string): URL

  • This function ensures that path is resolved absolutely, and that the URL control characters are correctly encoded when converting into a File URL.

    Parameters

    • url: string

      The path to convert to a File URL.

    Returns URL

resolve

  • resolve(from: string, to: string): string
  • deprecated

    since v11.0.0 - Use the WHATWG URL API.

    Parameters

    • from: string
    • to: string

    Returns string

Generated using TypeDoc