Cara memanfaatkan sepenuhnya konsol JavaScript

Salah satu alat penyahpepijatan paling asas dalam JavaScript adalah console.log(). Ia consoledilengkapi dengan beberapa kaedah berguna lain yang dapat menambah alat debugging pemaju.

Anda boleh menggunakan consoleuntuk melakukan beberapa tugas berikut:

  • Keluarkan pemasa untuk membantu penanda aras sederhana
  • Keluarkan jadual untuk memaparkan array atau objek dalam format yang mudah dibaca
  • Terapkan warna dan pilihan gaya lain pada output dengan CSS

Objek Konsol

The consoleobjek memberikan anda akses ke konsol pelayar. Ini membolehkan anda mengeluarkan rentetan, tatasusunan, dan objek yang membantu menyahpepijat kod anda. Ini consoleadalah bahagian windowobjek, dan dibekalkan oleh Model Objek Penyemak Imbas (BOM).

Kami boleh mendapatkan akses ke consolesalah satu daripada dua cara:

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

Pilihan kedua pada dasarnya adalah merujuk kepada yang pertama, jadi kita akan menggunakan yang terakhir untuk menyimpan ketukan kekunci.

Satu catatan ringkas mengenai BOM: ia tidak mempunyai standard yang ditetapkan, jadi setiap penyemak imbas menerapkannya dengan cara yang sedikit berbeza. Saya menguji semua contoh saya di Chrome dan Firefox, tetapi output anda mungkin kelihatan berbeza bergantung pada penyemak imbas anda.

Mengeluarkan teks

Unsur consoleobjek yang paling biasa adalah console.log. Untuk kebanyakan senario, anda akan menggunakannya untuk menyelesaikan tugas.

Terdapat empat cara mengeluarkan mesej ke konsol:

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

Keempat-empatnya bekerja dengan cara yang sama. Yang anda buat hanyalah menyampaikan satu atau lebih hujah ke kaedah yang dipilih. Kemudian memaparkan ikon yang berbeza untuk menunjukkan tahap pembalakannya. Dalam contoh di bawah, anda dapat melihat perbezaan antara log peringkat maklumat dan log peringkat amaran / ralat.

Anda mungkin menyedari mesej log ralat - lebih menarik daripada yang lain. Ia memaparkan latar belakang merah dan jejak timbunan, di mana infodan warn tidak. Walaupun warnmempunyai latar belakang kuning di Chrome.

Perbezaan visual ini membantu apabila anda perlu mengenal pasti sebarang kesalahan atau amaran di konsol dengan cepat. Anda ingin memastikan bahawa aplikasi tersebut dikeluarkan untuk aplikasi siap pengeluaran, kecuali mereka ada untuk memberi amaran kepada pembangun lain bahawa mereka melakukan sesuatu yang salah dengan kod anda.

Penggantian Rentetan

Teknik ini menggunakan placeholder dalam rentetan yang digantikan oleh argumen lain yang anda lalui untuk kaedah ini. Sebagai contoh:

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

Keluaran :string substitutions

Ini %sadalah tempat bagi argumen kedua 'substitutions'yang muncul selepas koma. Segala rentetan, bilangan bulat, atau tatasusunan akan ditukar menjadi rentetan dan akan menggantikannya %s. Sekiranya anda melewati objek, ia akan dipaparkan [object Object].

Sekiranya anda ingin melepasi objek, anda perlu menggunakan %oatau %Obukan %s.

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

Nombor

Penggantian tali boleh digunakan dengan bilangan bulat dan nilai titik terapung dengan menggunakan:

  • %iatau %duntuk bilangan bulat,
  • %f untuk titik terapung.

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

Keluaran :int: 1, floating-point: 1.500000

Float dapat diformat untuk memaparkan hanya satu digit setelah titik perpuluhan dengan menggunakan %.1f. Anda boleh lakukan %.nfuntuk memaparkan jumlah digit selepas perpuluhan.

Sekiranya kita memformat contoh di atas untuk memaparkan satu digit selepas titik perpuluhan untuk nombor titik terapung, ia akan kelihatan seperti ini:

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

Keluaran :int: 1, floating-point: 1.5

Pemformat pemformatan

  1. %s| menggantikan unsur dengan rentetan
  2. %(d|i)| menggantikan unsur dengan bilangan bulat
  3. %f | menggantikan elemen dengan apungan
  4. %(o|O)| elemen dipaparkan sebagai objek.
  5. %c| Menggunakan CSS yang disediakan

Templat Rentetan

Dengan munculnya ES6, literal templat adalah alternatif untuk penggantian atau penggabungan. Mereka menggunakan tanda belakang (``) dan bukannya tanda petik, dan pemboleh ubah masuk ke dalam ${}:

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

Objek dipaparkan seperti [object Object]dalam literal templat, jadi anda perlu menggunakan penggantian dengan %oatau %Ountuk melihat perinciannya, atau mencatatnya 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.