Difference between "process.stdout.write" and "console.log" in node.js?

Dive deeper: Understanding their core differences

Lower-level vs. High-level functionality

By nature, process.stdout.write is a stream-based interface which makes it part of Node.js's lower-level API for output. On the other hand, console.log is a high-level API that provides convenience and formatting.

Data type handling and formatting

console.log can work with any JavaScript data type. It even handles multiple arguments, joining them with a space:

console.log('String', { key: 'value' }, [1, 2, 3]); // Automatic formatting, no manual labor required!


Meanwhile, process.stdout.write is a bit pickier — it expects a string or a Buffer. If you're dealing with non-string values, you need to convert them manually:

process.stdout.write(JSON.stringify({ key: 'value' })); // Needs manual conversion, still a good chap though.


Line output control

When you aim for dynamic inline updates, such as creating an impressively interactive progress bar, process.stdout.write is your best friend:

process.stdout.write('Loading...');
setTimeout(() => {
  process.stdout.clearLine();  // Clears the current text
  process.stdout.cursorTo(0);  // Moves cursor back to start of the line
  process.stdout.write('Done!');
}, 1000);


Under the hood

For tech enthusiasts who love to dig deeper, the source code of Node.js in GitHub, particularly the console.js file, can provide fantastic insights. Lo and behold, Console.prototype.log does call process.stdout.write, but with dressed-up output including that neat newline at the end.

Practical use cases

Progress tracking with process.stdout.write

For real-time updates in a progress bar or showing incremental changes on the same line, process.stdout.write lends you the necessary fine control:

// Example: updating a progress bar
function updateProgress(percent) {
  process.stdout.clearLine(); // Clears current line
  process.stdout.cursorTo(0); // Moves cursor back to the start
  process.stdout.write(`Progress: ${percent}%`); // Show 'em the progress!
}


Information logging with console.log

For your daily logging needs, console.log offers the speed and ease you'll appreciate. It handles multiple data types and formats text for you:

// Logging information with console.log
console.log('Server started on port', port); // Logs like a seasoned lumberjack!


Exploring use cases in the source code

Diving into the source code of Node.js provides first-hand insights into when to use each method. It can help demystify the unexpected scenarios where unfriendly characters make an appearance using console.log.

Real-world examples

Error handling

Error handling is an important part of programming, and both methods can play a role. While console.log is typically used for standard output, console.error is its counterpart for error messages, which also rely on process.stderr.write underneath.

Clear object display with process.stdout.write

When custom formatting is crucial, process.stdout.write can be effectively used for a clear and concise representation of objects, courtesy of its no-newline advantage.

Console customization

Understanding the workings of console.log and process.stdout.write can help you customize the console object. This can enable overriding default behavior or even creating a tailor-made custom logging function.