Node.js built-in module support in Deno - Mini Project: Build & Apply

Node.js Built-in Module Support in Deno

📖 Scenario: You are building a simple Deno script that uses Node.js built-in modules to read a file and display its content. This helps you understand how Deno supports Node.js modules.

🎯 Goal: Create a Deno script that imports the Node.js fs module, reads a file named example.txt, and logs its content to the console.

📋 What You'll Learn

Import the Node.js fs module using Deno's compatibility layer

Create a variable filePath with the value 'example.txt'

Use fs.readFileSync to read the file content into a variable content

Log the file content as a string using console.log

💡 Why This Matters

🌍 Real World

Many developers use Deno to run JavaScript and TypeScript outside the browser. Supporting Node.js built-in modules helps reuse existing code and libraries easily.

💼 Career

Understanding how to work with Node.js modules in Deno is useful for backend developers who want to migrate or write cross-platform scripts and applications.

1

Import the Node.js fs module

Write an import statement to import fs from 'node:fs' using Deno's compatibility support.

Deno

// Import the fs module from 'node:fs'
// Your code here

Hint

Use import * as fs from 'node:fs'; to import the entire fs module.

2

Create the file path variable

Create a variable called filePath and set it to the string 'example.txt'.

Deno

import * as fs from 'node:fs';

// Create a variable filePath with value 'example.txt'
// Your code here

Hint

Use const filePath = 'example.txt'; to create the variable.

3

Read the file content

Use fs.readFileSync with filePath to read the file content into a variable called content.

Deno

import * as fs from 'node:fs';

const filePath = 'example.txt';

// Read the file content into variable content
// Your code here

Hint

Use const content = fs.readFileSync(filePath); to read the file.

4

Log the file content as a string

Use console.log to print the content variable converted to a string using toString().

Deno

import * as fs from 'node:fs';

const filePath = 'example.txt';

const content = fs.readFileSync(filePath);

// Log the content as a string
// Your code here

Hint

Use console.log(content.toString()); to display the file content.

Practice

1. What is the correct way to import the Node.js built-in path module in Deno?

easy

A. import * as path from "deno_path";

B. import path from "path";

C. import { path } from "deno:path";

D. import path from "node:path";

Solution

1. Step 1: Understand Deno's Node.js module import syntax

   Deno uses the "node:" prefix to import Node.js built-in modules.

2. Step 2: Apply correct import statement for path

   The correct import is import path from "node:path"; to access Node.js path module in Deno.

3. Final Answer:

   import path from "node:path"; -> Option D

4. Quick Check:

   Node.js built-in modules use "node:" prefix in Deno [OK]

Hint: Use "node:" prefix to import Node.js built-ins in Deno [OK]

Common Mistakes:

• Omitting the "node:" prefix
• Using "deno:" prefix instead
• Trying to import from "path" without prefix
• Using incorrect module names

2. Which of the following is the correct syntax to import the Node.js fs module in Deno?

easy

A. import * as fs from "node:fs";

B. import { fs } from "node:fs";

C. import fs from "fs";

D. import fs from "deno:fs";

Solution

1. Step 1: Recall import style for Node.js modules in Deno

   Deno requires the "node:" prefix and supports namespace import for modules like fs.

2. Step 2: Choose correct import syntax for fs

   The correct syntax is import * as fs from "node:fs"; to import all fs exports as a namespace.

3. Final Answer:

   import * as fs from "node:fs"; -> Option A

4. Quick Check:

   Namespace import with "node:" prefix is correct [OK]

Hint: Use namespace import with "node:" prefix for modules like fs [OK]

Common Mistakes:

• Using default import for modules that export multiple members
• Omitting the "node:" prefix
• Trying to destructure import incorrectly
• Using "deno:" prefix

3. What will be the output of the following Deno code snippet?

import { join } from "node:path";
const fullPath = join("/home", "user", "docs");
console.log(fullPath);

medium

A. /home\user\docs

B. /home/user/docs

C. home/user/docs

D. Error: Module not found

Solution

1. Step 1: Understand join from Node.js path module

   The join function combines path segments using the correct separator for the OS.

2. Step 2: Analyze the given path segments

   Segments "/home", "user", "docs" joined on Unix-like OS produce "/home/user/docs".

3. Final Answer:

   /home/user/docs -> Option B

4. Quick Check:

   Node.js path.join joins segments with OS separator [OK]

Hint: Node.js path.join joins paths with OS-specific separator [OK]

Common Mistakes:

• Assuming Windows separator on Unix
• Expecting error due to import
• Confusing join with concat
• Ignoring leading slash in first segment

4. Identify the error in this Deno code importing Node.js buffer module:

import { Buffer } from "buffer";
const buf = Buffer.from("hello");
console.log(buf.toString());

medium

A. Missing "node:" prefix in import path

B. Buffer is not exported from Node.js buffer module

C. Buffer.from is not a function

D. toString() method does not exist on Buffer

Solution

1. Step 1: Check import path for Node.js built-in modules in Deno

   Deno requires the "node:" prefix to import Node.js built-in modules like buffer.

2. Step 2: Identify the missing prefix causing module resolution error

   Importing from "buffer" without "node:" prefix will fail in Deno.

3. Final Answer:

   Missing "node:" prefix in import path -> Option A

4. Quick Check:

   Always use "node:" prefix for Node.js built-ins in Deno [OK]

Hint: Always prefix Node.js modules with "node:" in Deno imports [OK]

Common Mistakes:

• Omitting the "node:" prefix
• Assuming default import works without prefix
• Confusing Deno modules with Node.js modules
• Misunderstanding Buffer API

5. You want to use the Node.js events module in Deno to create an event emitter. Which code snippet correctly imports and uses it?

hard

A. import EventEmitter from "node:events";
const emitter = new EventEmitter();

B. import { EventEmitter } from "node:events";
const emitter = new events.EventEmitter();

C. import * as events from "node:events";
const emitter = new events.EventEmitter();

D. import events from "events";
const emitter = new events.EventEmitter();

Solution

1. Step 1: Understand how Node.js events module exports EventEmitter

   The events module exports EventEmitter as a named export, so namespace import is common.

2. Step 2: Check correct import syntax with "node:" prefix and usage

   Using import * as events from "node:events"; then new events.EventEmitter() is correct in Deno.

3. Final Answer:

   import * as events from "node:events"; const emitter = new events.EventEmitter(); -> Option C

4. Quick Check:

   Namespace import with "node:" prefix for EventEmitter [OK]

Hint: Use namespace import for EventEmitter from "node:events" [OK]

Common Mistakes:

• Using default import for EventEmitter
• Omitting "node:" prefix
• Importing from "events" without prefix
• Trying to destructure EventEmitter incorrectly