Encoding and decoding URLs in Node.js

Introduction

Encoding and decoding URLs helps make sure web addresses work correctly by handling special characters safely.

When sending data in a URL query string that may contain spaces or symbols.

When reading a URL and you want to get the original text from encoded parts.

When building links dynamically that include user input or special characters.

When you want to avoid errors caused by characters that have special meaning in URLs.

Syntax

Node.js

encodeURIComponent(string)
decodeURIComponent(string)

Use encodeURIComponent to safely convert text into a URL-friendly format.

Use decodeURIComponent to convert encoded URL parts back to normal text.

Examples

Encodes spaces and special characters so the string can be used in a URL.

Node.js

const encoded = encodeURIComponent('Hello World!');
console.log(encoded);

Decodes the encoded string back to the original text.

Node.js

const decoded = decodeURIComponent('Hello%20World%21');
console.log(decoded);

Builds a URL with a query parameter that includes special characters safely.

Node.js

const url = `https://example.com/search?query=${encodeURIComponent('node.js & url')}`;
console.log(url);

Sample Program

This program encodes a search term to safely include it in a URL, then decodes a received encoded string back to normal text.

Node.js

const searchTerm = 'coffee & cream';
const encodedTerm = encodeURIComponent(searchTerm);
const url = `https://example.com/search?query=${encodedTerm}`;
console.log('Encoded URL:', url);

const receivedParam = 'coffee%20%26%20cream';
const decodedTerm = decodeURIComponent(receivedParam);
console.log('Decoded term:', decodedTerm);

Important Notes

Never encode an entire URL with encodeURIComponent; only encode parts like query parameters.

Decoding a string that is not properly encoded can cause errors, so decode only encoded strings.

Use encodeURIComponent instead of escape, as escape is outdated and does not handle all characters correctly.

Summary

Encoding converts special characters into a safe format for URLs.

Decoding converts encoded URL parts back to readable text.

Use encodeURIComponent and decodeURIComponent for handling URL parts safely.

Practice

1. What does the encodeURIComponent function do in Node.js?

easy

A. It decodes an encoded URL string back to normal text.

B. It parses a URL into its components.

C. It sends an HTTP request to a URL.

D. It converts special characters in a string into a format safe for URLs.

Solution

1. Step 1: Understand the purpose of encoding URLs

   Encoding converts special characters like spaces or symbols into a safe format for URLs.

2. Step 2: Identify the role of encodeURIComponent

   This function specifically encodes parts of a URL so they can be safely transmitted.

3. Final Answer:

   It converts special characters in a string into a format safe for URLs. -> Option D

4. Quick Check:

   Encoding = safe URL string [OK]

Hint: Encoding makes URL parts safe by replacing special characters [OK]

Common Mistakes:

• Confusing encoding with decoding
• Thinking it sends HTTP requests
• Assuming it parses URLs

2. Which of the following is the correct syntax to decode a URL-encoded string in Node.js?

easy

A. decodeURIComponent('https%3A%2F%2Fexample.com')

B. decodeURI('https://example.com')

C. encodeURIComponent('https://example.com')

D. encodeURI('https%3A%2F%2Fexample.com')

Solution

1. Step 1: Identify the function to decode URL components

   decodeURIComponent is used to decode encoded parts of a URL.

2. Step 2: Check the syntax correctness

   The syntax decodeURIComponent('https%3A%2F%2Fexample.com') correctly decodes the encoded string.

3. Final Answer:

   decodeURIComponent('https%3A%2F%2Fexample.com') -> Option A

4. Quick Check:

   Decoding syntax = decodeURIComponent() [OK]

Hint: Use decodeURIComponent() to decode encoded URL parts [OK]

Common Mistakes:

• Using encode functions to decode
• Using decodeURI which decodes less strictly
• Mixing encodeURI and decodeURIComponent

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

const encoded = encodeURIComponent('Hello World!');
console.log(encoded);

medium

A. Hello%World%!

B. Hello+World!

C. Hello%20World%21

D. Hello World!

Solution

1. Step 1: Understand what encodeURIComponent does to spaces and special characters

   Spaces become %20 and exclamation marks become %21 in encoding.

2. Step 2: Apply encoding to 'Hello World!'

   The space is replaced by %20 and '!' by %21, resulting in 'Hello%20World%21'.

3. Final Answer:

   Hello%20World%21 -> Option C

4. Quick Check:

   Space = %20, ! = %21 [OK]

Hint: Spaces become %20, special chars like ! become %21 [OK]

Common Mistakes:

• Expecting spaces to become '+'
• Confusing encodeURI with encodeURIComponent
• Not encoding special characters

4. Identify the error in this Node.js code snippet:

const url = 'https://example.com/search?query=Node.js';
const encodedUrl = encodeURIComponent(url);
console.log(encodedUrl);

medium

A. No error; code works correctly.

B. Should use encodeURI instead of encodeURIComponent for full URLs.

C. Missing decodeURIComponent call after encoding.

D. encodeURIComponent cannot encode dots ('.').

Solution

1. Step 1: Understand difference between encodeURI and encodeURIComponent

   encodeURIComponent encodes all special characters, including ':' and '/', which breaks full URLs.

2. Step 2: Identify correct function for full URLs

   encodeURI is designed to encode full URLs without breaking their structure.

3. Final Answer:

   Should use encodeURI instead of encodeURIComponent for full URLs. -> Option B

4. Quick Check:

   Full URL encoding = encodeURI() [OK]

Hint: Use encodeURI for full URLs, encodeURIComponent for parts [OK]

Common Mistakes:

• Using encodeURIComponent on full URLs
• Expecting decode after encoding always
• Thinking dots cannot be encoded

5. You want to safely encode a URL query parameter that contains an email address like [e-mail]. Which code snippet correctly encodes this parameter for use in a URL?

hard

A. const param = encodeURIComponent('[e-mail]');

B. const param = encodeURI('[e-mail]').replace(/@/g, '+');

C. const param = encodeURIComponent('[e-mail]').replace(/%40/g, '@');

D. const param = encodeURI('[e-mail]');

Solution

1. Step 1: Determine correct encoding for query parameters

   Query parameters should be encoded with encodeURIComponent to encode special characters like '@'.

2. Step 2: Check each option's correctness

   const param = encodeURI('[e-mail]'); uses encodeURI which does not encode '@'. const param = encodeURI('[e-mail]').replace(/@/g, '+'); uses encodeURI and replaces '@' with '+', but '+' is interpreted as space in query strings. const param = encodeURIComponent('[e-mail]').replace(/%40/g, '@'); uses encodeURIComponent but then decodes '%40' back to '@'. const param = encodeURIComponent('[e-mail]');: const param = encodeURIComponent('[e-mail]'); correctly encodes '@' as '%40'.

3. Final Answer:

   const param = encodeURIComponent('[e-mail]'); -> Option A

4. Quick Check:

   Query param encoding = encodeURIComponent() [OK]

Hint: Use encodeURIComponent for query parameters including emails [OK]

Common Mistakes:

• Using encodeURI for query parameters
• Manually replacing encoded characters incorrectly
• Not encoding '@' in emails