Relative vs absolute URL resolution in Node.js

Introduction

We use relative and absolute URLs to tell programs where to find web pages or resources. Understanding how Node.js resolves these URLs helps us load the right files or links.

When you want to link to a file or page within the same website using a short path.

When you need to specify a full web address to access resources from anywhere on the internet.

When building a server that handles requests and needs to resolve paths correctly.

When combining base URLs with relative paths to get the full address.

When working with APIs that require full URLs or relative paths.

Syntax

Node.js

new URL(input, base);

input is the URL string you want to resolve.

base is the base URL used to resolve relative URLs. If input is absolute, base is ignored.

Examples

This resolves the relative path /path/page.html against the base URL https://example.com/folder/, resulting in https://example.com/path/page.html.

Node.js

const url = new URL('/path/page.html', 'https://example.com/folder/');
console.log(url.href);

This uses an absolute URL, so no base is needed. The output is the same URL.

Node.js

const url = new URL('https://google.com/search');
console.log(url.href);

This resolves a relative path without a leading slash, so it appends to the base path, resulting in https://example.com/gallery/images/photo.png.

Node.js

const url = new URL('images/photo.png', 'https://example.com/gallery/');
console.log(url.href);

Sample Program

This example shows how Node.js resolves different URLs using the URL class. It prints the full resolved URLs for relative and absolute inputs.

Node.js

import { URL } from 'url';

// Relative URL with base
const relativeUrl = new URL('docs/tutorial.html', 'https://site.com/start/');
console.log(relativeUrl.href);

// Absolute URL ignores base
const absoluteUrl = new URL('https://other.com/page');
console.log(absoluteUrl.href);

// Relative URL with leading slash replaces path
const rootRelativeUrl = new URL('/about', 'https://site.com/start/');
console.log(rootRelativeUrl.href);

Important Notes

Relative URLs without a leading slash append to the base path.

Relative URLs with a leading slash replace the path part of the base URL.

Absolute URLs ignore the base and stand alone.

Summary

Relative URLs depend on a base URL to form a full address.

Absolute URLs are complete and do not need a base.

Node.js URL class helps combine and resolve URLs correctly.

Practice

1. Which of the following is a correct description of a relative URL in Node.js?

easy

A. A URL that includes the protocol and domain name.

B. A URL that depends on a base URL to form a full address.

C. A URL that always starts with 'http://' or 'https://'.

D. A URL that cannot be resolved using the URL class.

Solution

1. Step 1: Understand relative URL meaning

   A relative URL does not include the full path and depends on a base URL to form a complete address.

2. Step 2: Compare options

   A URL that depends on a base URL to form a full address. correctly describes this. Options B and C describe absolute URLs. A URL that cannot be resolved using the URL class. is incorrect because Node.js URL class can resolve relative URLs with a base.

3. Final Answer:

   A URL that depends on a base URL to form a full address. -> Option B

4. Quick Check:

   Relative URL = depends on base URL [OK]

Hint: Relative URLs need a base URL to become complete [OK]

Common Mistakes:

• Confusing relative URLs with absolute URLs
• Thinking relative URLs include protocol
• Believing relative URLs cannot be resolved

2. Which of the following is the correct way to create a new URL object for a relative path '/images/photo.jpg' with base 'https://example.com/gallery/' in Node.js?

easy

A. new URL('/images/photo.jpg', 'https://example.com/gallery/')

B. new URL('https://example.com/gallery/' + '/images/photo.jpg')

C. new URL('images/photo.jpg')

D. new URL('https://example.com/gallery/images/photo.jpg')

Solution

1. Step 1: Understand URL constructor usage

   The URL constructor takes two arguments: the path and the base URL. For relative paths, the first argument is the relative path, and the second is the base.

2. Step 2: Check each option

   new URL('/images/photo.jpg', 'https://example.com/gallery/') correctly uses new URL(relativePath, baseURL). new URL('https://example.com/gallery/' + '/images/photo.jpg') concatenates strings but does not use the URL constructor properly. new URL('images/photo.jpg') misses the base URL. new URL('https://example.com/gallery/images/photo.jpg') uses an absolute URL, not relative.

3. Final Answer:

   new URL('/images/photo.jpg', 'https://example.com/gallery/') -> Option A

4. Quick Check:

   URL(relative, base) = correct syntax [OK]

Hint: Use new URL(relativePath, baseURL) for relative URLs [OK]

Common Mistakes:

• Concatenating strings instead of using URL constructor
• Omitting the base URL for relative paths
• Passing absolute URL as first argument when base is given

3. What will be the output of the following Node.js code?

const { URL } = require('url');
const base = 'https://example.com/folder/';
const relative = '../image.png';
const fullUrl = new URL(relative, base);
console.log(fullUrl.href);

medium

A. https://example.com/folder/../image.png

B. Error: Invalid URL

C. https://example.com/image.png

D. https://example.com/folder/image.png

Solution

1. Step 1: Understand relative path resolution

   The relative path '../image.png' means go one folder up from 'https://example.com/folder/' which leads to 'https://example.com/'.

2. Step 2: Resolve the full URL

   Combining base and relative path, the URL class normalizes the path to 'https://example.com/image.png'. https://example.com/image.png matches this.

3. Final Answer:

   https://example.com/image.png -> Option C

4. Quick Check:

   Relative '..' moves up one directory [OK]

Hint: Relative '..' moves up one folder in URL paths [OK]

Common Mistakes:

• Not normalizing '..' in URL paths
• Expecting '../' to stay in the URL string
• Confusing relative and absolute URL outputs

4. Identify the error in this Node.js code snippet that tries to resolve a relative URL:

const { URL } = require('url');
const base = 'https://example.com/path';
const relative = 'file.txt';
const url = new URL(relative, base);
console.log(url.href);

medium

A. Base URL is missing trailing slash, causing incorrect resolution.

B. Relative URL should start with a slash '/' to be valid.

C. URL constructor requires only one argument for relative URLs.

D. No error; code outputs 'https://example.com/path/file.txt' correctly.

Solution

1. Step 1: Check base URL format

   The base URL 'https://example.com/path' lacks a trailing slash, so it is treated as a file, not a folder.

2. Step 2: Understand URL resolution effect

   Appending 'file.txt' to a base treated as file replaces 'path' with 'file.txt', resulting in 'https://example.com/file.txt', not 'https://example.com/path/file.txt'.

3. Final Answer:

   Base URL is missing trailing slash, causing incorrect resolution. -> Option A

4. Quick Check:

   Base URL trailing slash affects relative URL resolution [OK]

Hint: Always add trailing slash to base URL if it's a folder [OK]

Common Mistakes:

• Omitting trailing slash on base URL
• Thinking relative URLs must start with '/'
• Passing wrong number of arguments to URL constructor

5. You want to combine a base URL 'https://example.com/api/v1/' with a relative URL '../../images/pic.jpg' in Node.js. What will be the resolved absolute URL?

hard

A. https://example.com/api/v1/images/pic.jpg

B. https://example.com/api/images/pic.jpg

C. https://example.com/api/v1/../../images/pic.jpg

D. https://example.com/images/pic.jpg

Solution

1. Step 1: Analyze relative path '../../images/pic.jpg'

   The '../../' means go up two folders from 'https://example.com/api/v1/'.

2. Step 2: Move up two levels from base URL

   Starting at 'https://example.com/api/v1/', going up one level is 'https://example.com/api/', and up another is 'https://example.com/'. Then append 'images/pic.jpg'.

3. Final Answer:

   https://example.com/images/pic.jpg -> Option D

4. Quick Check:

   Two '..' moves up two directories [OK]

Hint: Count '..' to move up folders in URL paths [OK]

Common Mistakes:

• Not moving up enough folders for multiple '..'
• Appending relative path without normalization
• Confusing base URL folder levels