What is the difference between "process.stdout.write" and "console.log" in node.js?
EDIT: Using console.log for a variable showed a lot of unreadable characters while using process.stdout.write showed an object.
Why is that?
console.log()
calls process.stdout.write
with formatted output. See format()
in console.js for the implementation.
Currently (v0.10.ish):
Console.prototype.log = function() {
this._stdout.write(util.format.apply(this, arguments) + '\n');
};
Looking at the Node docs apparently console.log is just process.stdout.write with a line-break at the end:
console.log = function (d) {
process.stdout.write(d + '\n');
};
Source: http://nodejs.org/docs/v0.3.1/api/process.html#process.stdout
I know this is a very old question but I didn't see anybody talking about the main difference between process.stdout.write
and console.log
and I just want to mention it.
As Mauvis Leford and TK-421 pointed out, the console.log
adds a line-break
character at the end of the line (\n
) but that's not all what it does.
The code has not changed since at least 0.10.X
version and now we have a a 5.X
version.
Here is the code:
Console.prototype.log = function() {
this._stdout.write(util.format.apply(this, arguments) + '\n');
};
As you can see, there is a part that says .apply(this, arguments)
and that makes a big difference on functionality. It is easier to explain that with examples:
process.stdout.write
has a very basic functionality, you can just write something in there, like this:
process.stdout.write("Hello World\n");
If you don't put the break line at the end you will get a weird character after your string, something like this:
process.stdout.write("Hello World"); //Hello World%
(I think that means something like "the end of the program", so you will see it only if you process.stdout.write
was used at the end of your file and you didn't add the break line)
On the other hand, console.log
can do more.
You can use it in the same way console.log("Hello World"); //You don't need the break line here because it was already formated and also that weird character did disappear You can write more than one string console.log("Hello", "World"); You can make associations console.log("Hello %s", "World") //Useful when "World" is inside a variable
An that's it, that added functionality is given thanks to the util.format.apply
part (I could talk a lot about what exactly this does but you get my point, you can read more here).
I hope somebody find this information useful.
stdout.write
and avoid getting %
%
at the end by simply calling process.stdout.write('\n');
at the end of my loop (if you have for example)
%
is just the shell's way of saying there's no newline at the end of the file.
%
in the file
One big difference that hasn't been mentioned is that process.stdout only takes strings as arguments (can also be piped streams), while console.log takes any Javascript data type.
e.g:
// ok
console.log(null)
console.log(undefined)
console.log('hi')
console.log(1)
console.log([1])
console.log({one:1})
console.log(true)
console.log(Symbol('mysymbol'))
// any other data type passed as param will throw a TypeError
process.stdout.write('1')
// can also pipe a readable stream (assuming `file.txt` exists)
const fs = require('fs')
fs.createReadStream('file.txt').pipe(process.stdout)
Another important difference in this context would with process.stdout.clearLine()
and process.stdout.cursorTo(0)
.
This would be useful if you want to show percentage of download or processing in the only one line. If you use clearLine(), cursorTo() with console.log()
it doesn't work because it also append \n to the text. Just try out this example:
var totalTime = 5000;
var waitInterval = totalTime / 10;
var currentInterval = 0;
function showPercentage(percentage){
process.stdout.clearLine()
process.stdout.cursorTo(0)
console.log(`Processing ${percentage}%...` ) // Replace this line with process.stdout.write(`Processing ${percentage}%...`)
}
var interval = setInterval(function(){
currentInterval += waitInterval
showPercentage((currentInterval / totalTime) * 100)
}, waitInterval)
setTimeout(function(){
clearInterval(interval)
}, totalTime + 100)
I've just noticed something while researching this after getting help with https.request for post method. Thought I share some input to help understand.
process.stdout.write
doesn't add a new line while console.log
does, like others had mentioned. But there's also this which is easier to explain with examples.
var req = https.request(options, (res) => {
res.on('data', (d) => {
process.stdout.write(d);
console.log(d)
});
});
process.stdout.write(d);
will print the data properly without a new line. However console.log(d)
will print a new line but the data won't show correctly, giving this <Buffer 12 34 56...
for example.
To make console.log(d)
show the information correctly, I would have to do this.
var req = https.request(options, (res) => {
var dataQueue = "";
res.on("data", function (d) {
dataQueue += d;
});
res.on("end", function () {
console.log(dataQueue);
});
});
So basically:
process.stdout.write continuously prints the information as the data being retrieved and doesn't add a new line.
console.log prints the information what was obtained at the point of retrieval and adds a new line.
That's the best way I can explain it.
The Simple Difference is: console.log() methods automatically append new line character. It means if we are looping through and printing the result, each result get printed in new line.
process.stdout.write() methods don't append new line character. useful for printing patterns.
Console.log implement process.sdout.write, process.sdout.write is a buffer/stream that will directly output in your console.
According to my puglin serverline : console = new Console(consoleOptions)
you can rewrite Console class with your own readline system.
You can see code source of console.log:
v14.x - lib/internal/console/constructor.js ;
and for old version: v10.0.0 - lib/console.js.
See more :
readline.createInterface to make your custom behavior or use console input.
console.log()
adds tons of things and a new line every time you call it
process.stdout.write()
is just plain text, no formatting
That's what I was taught at least
For those who like Deno, I was able to achieve this by using the following ANSI Escape Sequences in conjunction with Deno's version of process.stdout.write
.
ESC[2K clears entire line
ESC[#G moves cursor to column #
Code
/*
Console.log() to the same line
Supported in Deno 1.8.1
*/
const myTextEncoder : TextEncoder = new TextEncoder();
let counter : number = 0;
while(counter < 100000) {
// ESC[2K clears entire line
await Deno.stdout.write(myTextEncoder.encode(`\x1b[2K`));
// ESC[#G moves cursor to column #
await Deno.stdout.write(myTextEncoder.encode(`\x1b[0G`));
// OUTPUT incremented counter
await Deno.stdout.write(myTextEncoder.encode(`COUNTER: ${counter++}`));
}
Success story sharing
console.log()
appears to add a newlineconsole.log()
also broadcasts to debugging clients. To broadcast to debugging clients without printing to stdio, you can userequire('inspector').console.log()
.