Cara mendapatkan hasil maksimal dari konsol JavaScript

Salah satu alat debugging paling dasar di JavaScript adalah console.log(). The consoledilengkapi dengan beberapa metode yang berguna lainnya yang dapat menambah pengembang debugging toolkit.

Anda dapat menggunakan consoleuntuk melakukan beberapa tugas berikut:

  • Keluarkan pengatur waktu untuk membantu pembandingan sederhana
  • Output tabel untuk menampilkan larik atau objek dalam format yang mudah dibaca
  • Terapkan warna dan opsi gaya lainnya ke keluaran dengan CSS

Objek Konsol

The consoleobjek memberi Anda akses ke konsol browser. Ini memungkinkan Anda mengeluarkan string, array, dan objek yang membantu men-debug kode Anda. Itu consoleadalah bagian dari windowobjek, dan disediakan oleh Browser Object Model (BOM).

Kami bisa mendapatkan akses ke consolesalah satu dari dua cara berikut:

  1. window.console.log('This works')
  2. console.log('So does this')

Opsi kedua pada dasarnya adalah referensi ke yang pertama, jadi kami akan menggunakan yang terakhir untuk menyimpan penekanan tombol.

Satu catatan singkat tentang BOM: BOM tidak memiliki standar yang ditetapkan, jadi setiap browser menerapkannya dengan cara yang sedikit berbeda. Saya menguji semua contoh saya di Chrome dan Firefox, tetapi keluaran Anda mungkin tampak berbeda tergantung pada browser Anda.

Mengeluarkan teks

Elemen consoleobjek yang paling umum adalah console.log. Untuk sebagian besar skenario, Anda akan menggunakannya untuk menyelesaikan pekerjaan.

Ada empat cara berbeda untuk mengeluarkan pesan ke konsol:

  1. log
  2. info
  3. warn
  4. error

Keempatnya bekerja dengan cara yang sama. Yang Anda lakukan hanyalah meneruskan satu atau lebih argumen ke metode yang dipilih. Ini kemudian menampilkan ikon yang berbeda untuk menunjukkan tingkat loggingnya. Pada contoh di bawah ini, Anda dapat melihat perbedaan antara log tingkat info dan log tingkat peringatan / kesalahan.

Anda mungkin telah memperhatikan pesan log kesalahan - ini lebih mencolok daripada yang lain. Ini menampilkan latar belakang merah dan jejak tumpukan, di mana infodan warn tidak. Padahal warnmemang memiliki background kuning di Chrome.

Perbedaan visual ini membantu saat Anda perlu mengidentifikasi kesalahan atau peringatan apa pun di konsol dengan cepat. Anda ingin memastikan bahwa mereka dihapus untuk aplikasi siap produksi, kecuali mereka ada di sana untuk memperingatkan pengembang lain bahwa mereka melakukan sesuatu yang salah dengan kode Anda.

Substitusi String

Teknik ini menggunakan placeholder dalam string yang diganti dengan argumen lain yang Anda berikan ke metode. Sebagai contoh:

Masukan :console.log('string %s', 'substitutions')

Keluaran :string substitutions

Itu %sadalah placeholder untuk argumen kedua 'substitutions'yang muncul setelah koma. Setiap string, integer, atau array akan diubah menjadi string dan akan menggantikan %s. Jika Anda melewati suatu objek, itu akan ditampilkan [object Object].

Jika Anda ingin melewatkan suatu objek, Anda perlu menggunakan %oatau %Osebagai gantinya %s.

console.log('this is an object %o', { obj: { obj2: 'hello' }})

Angka

Substitusi string dapat digunakan dengan bilangan bulat dan nilai floating-point dengan menggunakan:

  • %iatau %duntuk bilangan bulat,
  • %f untuk floating-point.

Masukan :console.log('int: %d, floating-point: %f', 1, 1.5)

Keluaran :int: 1, floating-point: 1.500000

Float dapat diformat untuk menampilkan hanya satu digit setelah koma desimal dengan menggunakan %.1f. Anda dapat melakukannya %.nfuntuk menampilkan n jumlah digit setelah desimal.

Jika kita memformat contoh di atas untuk menampilkan satu digit setelah koma desimal untuk bilangan floating-point, maka akan terlihat seperti ini:

Masukan :console.log('int: %d, floating-point: %.1f', 1, 1.5)

Keluaran :int: 1, floating-point: 1.5

Penentu format

  1. %s| mengganti elemen dengan string
  2. %(d|i)| mengganti elemen dengan integer
  3. %f | mengganti elemen dengan pelampung
  4. %(o|O)| elemen ditampilkan sebagai objek.
  5. %c| Menerapkan CSS yang disediakan

Template String

Dengan hadirnya ES6, literal template merupakan alternatif pengganti atau penggabungan. Mereka menggunakan backticks (``) sebagai ganti tanda kutip, dan variabel masuk ke dalam ${}:

const a = 'substitutions';
console.log(`bear: ${a}`);
// bear: substitutions

Objek ditampilkan seperti [object Object]dalam template literal, jadi Anda harus menggunakan substitusi dengan %oatau %Ountuk melihat detailnya, atau mencatatnya sendiri secara terpisah.

Using substitutions or templates creates code that’s easier to read compared to using string concatenation: console.log('hello' + str + '!');.

Pretty color interlude!

Now it is time for something a bit more fun and colorful!

It is time to make our console pop with different colors with string substitutions.

I will be using a mocked Ajax example that give us both a success (in green) and failure (in red) to display. Here’s the output and code:

const success = [ 'background: green', 'color: white', 'display: block', 'text-align: center'].join(';');
const failure = [ 'background: red', 'color: white', 'display: block', 'text-align: center'].join(';');
console.info('%c /dancing/bears was Successful!', success);console.log({data: { name: 'Bob', age: 'unknown'}}); // "mocked" data response
console.error('%c /dancing/bats failed!', failure);console.log('/dancing/bats Does not exist');

You apply CSS rules in the string substitution with the %c placeholder.

console.error('%c /dancing/bats failed!', failure);

Then place your CSS elements as a string argument and you can have CSS-styled logs. You can add more than one %c into the string as well.

console.log('%cred %cblue %cwhite','color:red;','color:blue;', 'color: white;')

This will output the words ‘red’, ‘blue’ and ‘white’ in their respected colors.

There are quite a few CSS properties supported by the console. I would recommend experimenting to see what works and what doesn’t. Again, your results may vary depending on your browser.

Other available methods

Here are a few other available console methods. Note that some items below have not had their APIs standardized, so there may be incompatibilities between the browsers. The examples were created with Firefox 51.0.1.

Assert()

Assert takes two arguments — if the first argument evaluates to a falsy value, then it displays the second argument.

let isTrue = false;
console.assert(isTrue, 'This will display');
isTrue = true;
console.assert(isTrue, 'This will not');

If the assertion is false, it outputs to the console. It’s displayed as an error-level log as mentioned above, giving you both a red error message and a stack trace.

Dir()

The dir method displays an interactive list of the object passed to it.

console.dir(document.body);

Ultimately, dir only saves one or two clicks. If you need to inspect an object from an API response, then displaying it in this structured way can save you some time.

Table()

The table method displays an array or object as a table.

console.table(['Javascript', 'PHP', 'Perl', 'C++']);

The array’s indices or object property names come under the left-hand index column. Then the values are displayed in the right-hand column.

const superhero = { firstname: 'Peter', lastname: 'Parker',}console.table(superhero);

Note for Chrome users: This was brought to my attention by a co-worker but the above examples of the table method don’t seem to work in Chrome. You can work around this issue by placing any items into an array of arrays or an array of objects:

console.table([['Javascript', 'PHP', 'Perl', 'C++']]);
const superhero = { firstname: 'Peter', lastname: 'Parker',}console.table([superhero]); 

Group()

console.group() is made up of at least a minimum of three console calls, and is probably the method that requires the most typing to use. But it’s also one of the most useful (especially for developers using Redux Logger).

A somewhat basic call looks like this:

console.group();console.log('I will output');console.group();console.log('more indents')console.groupEnd();console.log('ohh look a bear');console.groupEnd();

This will output multiple levels and will display differently depending on your browser.

Firefox shows an indented list:

Chrome shows them in the style of an object:

Each call to console.group() will start a new group, or create a new level if it’s called inside a group. Each time you call console.groupEnd() it will end the current group or level and move back up one level.

I find the Chrome output style is easier to read since it looks more like a collapsible object.

You can pass group a header argument that will be displayed over console.group:

console.group('Header');

You can display the group as collapsed from the outset if you call console.groupCollapsed(). Based on my experience, this seems to work only in Chrome.

Time()

The time method, like the group method above, comes in two parts.

A method to start the timer and a method to end it.

Once the timer has finished, it will output the total runtime in milliseconds.

To start the timer, you use console.time('id for timer') and to end the timer you use console.timeEnd('id for timer') . You can have up to 10,000 timers running simultaneously.

The output will look a bit like this timer: 0.57ms

It is very useful when you need to do a quick bit of benchmarking.

Conclusion

There we have it, a bit of a deeper look into the console object and some of the other methods that come with it. These methods are great tools to have available when you need to debug code.

There are a couple of methods that I have not talked about as their API is still changing. You can read more about them or the console in general on the MDN Web API page and its living spec page.