node legacy url.parse deprecated, what to use instead?

Question

require('url').parse('someurl.com/page') have been docs-only deprecated, and our strict linter is unhappy about it... I have tried to replace it in our code with what the internet suggests new URL('someurl.com/page') which works in most cases.

However, we have examples where the url is a local image some/image.png and that was working nicely with url.parse() and returns:

Url {
  protocol: null,
  slashes: null,
  auth: null,
  host: null,
  port: null,
  hostname: null,
  hash: null,
  search: null,
  query: null,
  pathname: '/some/image.png',
  path: '/some/image.png',
  href: '/some/image.png'
}

But the suggested replacement new URL('some/image.png') throws a type error...

TypeError [ERR_INVALID_URL] [ERR_INVALID_URL]: Invalid URL: /some/image.png

url.parse is doing some validation and accept local paths, but the new url constructor does not. What to do ?

Saurabh Mistry · Accepted Answer · 2021-08-12 05:34:36Z

38

const server = http.createServer((req, res) => {
   const baseURL =  req.protocol + '://' + req.headers.host + '/';
   const reqUrl = new URL(req.url,baseURL);
   console.log(reqUrl);
});

will give reqUrl :

URL {
  href: 'http://127.0.0.1:3000/favicon.ico',
  origin: 'http://127.0.0.1:3000',
  protocol: 'http:',
  username: '',
  password: '',
  host: '127.0.0.1:3000',
  hostname: '127.0.0.1',
  port: '3000',
  pathname: '/favicon.ico',
  search: '',
  searchParams: URLSearchParams {},
  hash: ''
}

edited Aug 12, 2021 at 5:34

answered Jan 27, 2021 at 5:17

Saurabh Mistry

13.8k5 gold badges60 silver badges78 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

Klesun Over a year ago

baseURL = req.protocol + '://' + req.headers.host + '/'; would probably be more correct, as request could actually be https.

Shivam Over a year ago

the req.protocol is undefined

Eugene Over a year ago

use 'https' instead of req.protocol

nickc95 · Accepted Answer · 2020-01-09 19:57:51Z

17

You can use the base parameter of the URL constructor. For example:

new URL('some/image-png', "https://dummyurl.com")

For more info, https://nodejs.org/api/url.html#url_constructor_new_url_input_base.

answered Jan 9, 2020 at 19:57

nickc95

1794 bronze badges

4 Comments

Klesun Over a year ago

But I need an API that does not require me to know the domain name ;c. I don't want to rely on hardcode or environment variables for such task.

rofrol Over a year ago

@Klesun github.com/alwinb/reurl and stackoverflow.com/questions/48196706/new-url-whatwg-url-api/… and github.com/whatwg/url/issues/531

qrsngky Over a year ago

Even though I know that it's not really a URL when you don't have the base, I wonder why they don't provide an alternative other than using a fake dummy website.

papar Over a year ago

@Klesun the input base is optional.See my answer stackoverflow.com/a/73914067/2441641

Shivam · Accepted Answer · 2021-08-24 12:28:11Z

9

This is how to get the query string params without using any external modules

const http = require("http");

const server = http.createServer((req, res) => {
  const url = new URL(req.url, `http://${req.headers.host}/`);

  const query = new URLSearchParams(url.search);
  console.log(query.entries());

  res.end("I am done");
});

server.listen(3000);

answered Aug 24, 2021 at 12:28

Shivam

8711 gold badge13 silver badges18 bronze badges

1 Comment

Klesun Over a year ago

This approach matches the usage example in nodejs documentation, though the authors do admit that it's "not a particularly elegant one".

januw a · Accepted Answer · 2021-01-09 05:29:15Z

7

const path = require("path");
const url = require("url");

const p = path.join("public", "images", "a.jpg");

console.log(p);                                     // public\images\a.jpg
console.log(new url.URL(p, "http://xxx").pathname); // /public/images/a.jpg

answered Jan 9, 2021 at 5:29

januw a

2,3447 gold badges24 silver badges52 bronze badges

Comments

Eugene · Accepted Answer · 2023-12-24 13:46:26Z

1

Simply use new URL to parse get all data:

const server = http.createServer((req, res) => {
   const parsedUrl = new URL(req.url, `https://${req.headers.host}/`);
   console.log(parsedUrl);
});

And parsedUrl will consist all URL's data:

{
  href: 'https://localhost:5000/getIPData/?param=value',
  origin: 'https://localhost:5000',
  protocol: 'https:',
  username: '',
  password: '',
  host: 'localhost:5000',
  hostname: 'localhost',
  port: '5000',
  pathname: '/getIPData/',
  search: '?param=value',
  searchParams: URLSearchParams { 'param' => 'value' },
  hash: ''
}

Use http or https prefix depending on your protocol.

By the way, for getting query params values use:

parsedUrl.searchParams.get('param')

edited Dec 24, 2023 at 13:46

answered Dec 24, 2023 at 13:40

Eugene

1,2122 gold badges15 silver badges25 bronze badges

Comments

Brain · Accepted Answer · 2024-09-19 02:45:16Z

0

In my case, at first

import url from 'url';
const {query, pathname} = url.parse(req.url);

they show me url.parse is deprecated.

const {query, pathname} = url.parse(req.url, true);

It work for me, I forgot the boolean flag.

answered Sep 19, 2024 at 2:45

Brain

173 bronze badges

Comments

papar · Accepted Answer · 2022-09-30 21:21:38Z

-1

On Node v16.17.1.

This is what works for me:

const { URL } = require('url');

const url = new URL('https://somewebsite.com/params?x=x')

answered Sep 30, 2022 at 21:21

papar

1,09410 silver badges19 bronze badges

1 Comment

papar Feb 18 at 6:30

For those that down voted this answer, check your Node version first. It is clearly stated that this works on Node.js v16 and the question was asked many many years ago.

Collectives™ on Stack Overflow

node legacy url.parse deprecated, what to use instead?

7 Answers 7

3 Comments

4 Comments

This is how to get the query string params without using any external modules

1 Comment

Comments

Comments

Comments

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

7 Answers 7

3 Comments

4 Comments

This is how to get the query string params without using any external modules

1 Comment

Comments

Comments

Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related