Node.js: printing to console without a trailing newline?
Asked Answered
G

9

930

Is there a method for printing to the console without a trailing newline? The console object documentation doesn't say anything regarding that:

console.log()

Prints to stdout with newline. This function can take multiple arguments in a printf()-like way. Example:

console.log('count: %d', count);

If formating elements are not found in the first string then util.inspect is used on each argument.

Gemot answered 27/5, 2011 at 20:42 Comment(0)
I
1421

You can use process.stdout.write():

process.stdout.write("hello: ");

See the docs for details.

Inclement answered 27/5, 2011 at 20:51 Comment(5)
This solved the opposite problem for me. console.log was printing \n literally when I wanted it to print a newline character.Polymerize
@Paulpro isn't '\n' the newline char ?Sporogenesis
@AlexMills It's the escape sequence for a newline character, but it's not a newline character itself. I was getting a literal ` followed by an n`, when I wanted to output a real newline character.Polymerize
On Node.js prints hello: trueHoreb
When you need the new line after process.stdout.write('abc'); then write console.log();Additament
C
520

Also, if you want to overwrite messages in the same line, for instance in a countdown, you could add \r at the end of the string.

process.stdout.write("Downloading " + data.length + " bytes\r");
Caltrop answered 9/3, 2012 at 4:26 Comment(10)
Although not the answer to the question, this is an amazing answer. Can't wait to try.Ambassadress
This does not work on Windows for me. But works great on non-dows.Kidney
For Windows, you can use the equivalent code '\033[0G', as in: process.stdout.write("Downloading " + data.length + " bytes\033[0G");Vacuity
To make the ansi escape code given above in a comment by @Vacuity to work in strict mode, replace the octal literal \033 with the hex literal \x1b like this: \x1b[0G. (that works with both strict and non-strict code)Grappa
Just put the \r at the beginning rather than at the end of the string to make it work in Windows.Southsoutheast
This is great but how do you make it clear the contents of the line first? .write("goodbye\r") followed by .write("hi\r") results in hiodbyeBricky
You could first write spaces, for instance you could write ''.padEnd(str.length) where str is your original string to overwrite, then do your hello.Bilbrey
With ANSI escape codes as mentioned above, you can clear the line with .write("\x1b[0G\x1b[K");. Or without changing cursor position .write("\x1b[2K").Thermoelectric
This didn't work for me. I used: process.stdout.clearLine(); process.stdout.cursorTo(0);. I'm not certain if using the carriage return is a hack, but clearLine() and cursorTo() are found within the node.js documentationHobbledehoy
using @DaveF indication, I get this working process.stdout.clearLine(); process.stdout.cursorTo(0); process.stdout.write("Downloading " + i + " bytes\r")Parakeet
T
41

As an expansion/enhancement to the brilliant addition made by @rodowi above regarding being able to overwrite a row:

process.stdout.write("Downloading " + data.length + " bytes\r");

Should you not want the terminal cursor to be located at the first character, as I saw in my code, the consider doing the following:

let dots = ''
process.stdout.write(`Loading `)

let tmrID = setInterval(() => {
  dots += '.'
  process.stdout.write(`\rLoading ${dots}`)
}, 1000)

setTimeout(() => {
  clearInterval(tmrID)
  console.log(`\rLoaded in [3500 ms]`)
}, 3500)

By placing the \r in front of the next print statement the cursor is reset just before the replacing string overwrites the previous.

Tiemroth answered 27/12, 2017 at 0:33 Comment(0)
U
31

In Windows console (Linux, too), you should replace '\r' with its equivalent code \033[0G:

process.stdout.write('ok\033[0G');

This uses a VT220 terminal escape sequence to send the cursor to the first column.

Uttermost answered 28/1, 2014 at 16:52 Comment(6)
How would you go back up multiple lines instead of just the current line? The top program seems to be able to override my entire buffer while it's running and restores what was there when it's done. Anyone know how it does this? i.imgur.com/AtCmEjn.gifPrisoner
I believe it probably uses something like one of these: github.com/mscdex/node-ncurses github.com/chjj/blessedMattias
It works but I get the cursor as well like [\] 39 and the cursor is highlighted on the first char: var spinner = '|/-\\'.split('');process.stdout.write("["+this.randomElement(spinner)+"] "+message+"\033[0G");Farsighted
@Chev Top is special, not something you can write with ANSI escape codes. It does, indeed, use ncurses which is why you will not find it on embedded systems which do not have large C libsTaggart
@Chev: Most people will dissuade you from playing with hardcoded escape sequences due to their own FUD, but almost everyone uses VT100 now, so compatibility is not really an issue any more. The functionality you are referring to is "alternate screen" behavior. A basic intro can be found in man console_codes (on Linux or online) and my favorite reference is www2.phys.canterbury.ac.nz/dept/docs/manuals/unix/DEC_4.0e_Docs/… (99% of its contents still work). Only caveat: Be prepared to test any experiments on several different terminals before deploying widely.Disentitle
This is not work in strict mode because octal escapes are deprecated; start escape sequences with \u001b (instead of \033).Elfont
D
20

There seem to be many answers suggesting:

process.stdout.write

Error logs should be emitted on:

process.stderr

Instead use:

console.error

For anyone who is wonder why process.stdout.write('\033[0G'); wasn't doing anything it's because stdout is buffered and you need to wait for drain event (more info).

If write returns false it will fire a drain event.

Detector answered 18/8, 2015 at 1:40 Comment(0)
S
12

util.print can be used also. Read: http://nodejs.org/api/util.html#util_util_print

util.print([...])# A synchronous output function. Will block the process, cast each argument to a string then output to stdout. Does not place newlines after each argument.

An example:

// get total length
var len = parseInt(response.headers['content-length'], 10);
var cur = 0;

// handle the response
response.on('data', function(chunk) {
  cur += chunk.length;
  util.print("Downloading " + (100.0 * cur / len).toFixed(2) + "% " + cur + " bytes\r");
});
Seat answered 15/11, 2012 at 13:2 Comment(3)
util.print is deprecated nowNoreen
(node:7616) DeprecationWarning: util.print is deprecated. Use console.log instead.Bardwell
TypeError: util.print is not a functionHoreb
L
8

None of these solutions work for me, process.stdout.write('ok\033[0G') and just using '\r' just create a new line but don't overwrite on Mac OSX 10.9.2.

EDIT: I had to use this to replace the current line:

process.stdout.write('\033[0G');
process.stdout.write('newstuff');
Livonia answered 4/4, 2014 at 18:44 Comment(0)
W
5

I got the following error when using strict mode:

Node error: "Octal literals are not allowed in strict mode."

The following solution works (source):

process.stdout.write("received: " + bytesReceived + "\x1B[0G");
Weather answered 30/9, 2014 at 8:48 Comment(1)
Change the ocltal literal tobsone.orher numeric formatTriptych
B
3

If you want that to work both in Linux and Windows, strict mode and non strict mode, and to completely clear the line every time you print, you can use

const str = 'Hi there'
process.stdout.write(str.padEnd(50) + '\x1b[0G')
Breen answered 6/12, 2021 at 23:4 Comment(0)

© 2022 - 2024 — McMap. All rights reserved.