Skip to main content
parse - node__url.d.ts - Node documentation
function parse

Usage in Deno

```typescript import { parse } from "node:node__url.d.ts"; ```
parse(urlString: string): UrlWithStringQuery
Deprecated
Use the WHATWG URL API instead.
The `url.parse()` method takes a URL string, parses it, and returns a URL object. A `TypeError` is thrown if `urlString` is not a string. A `URIError` is thrown if the `auth` property is present but cannot be decoded. `url.parse()` uses a lenient, non-standard algorithm for parsing URL strings. It is prone to security issues such as [host name spoofing](https://hackerone.com/reports/678487) and incorrect handling of usernames and passwords. Do not use with untrusted input. CVEs are not issued for `url.parse()` vulnerabilities. Use the `WHATWG URL` API instead.

Parameters

urlString: string
The URL string to parse.

Return Type

parse(
urlString: string,
parseQueryString: false | undefined,
slashesDenoteHost?: boolean,
): UrlWithStringQuery

Parameters

urlString: string
parseQueryString: false | undefined
optional
slashesDenoteHost: boolean

Return Type

parse(
urlString: string,
parseQueryString: true,
slashesDenoteHost?: boolean,
): UrlWithParsedQuery

Parameters

urlString: string
parseQueryString: true
optional
slashesDenoteHost: boolean

Return Type

parse(
urlString: string,
parseQueryString: boolean,
slashesDenoteHost?: boolean,
): Url

Parameters

urlString: string
parseQueryString: boolean
optional
slashesDenoteHost: boolean

Return Type