Jak najlepiej wykorzystać konsolę JavaScript

Jednym z najbardziej podstawowych narzędzi do debugowania w JavaScript jest console.log(). consoleJest kilka innych przydatnych metod, które można dodać do programisty debugowania Toolkit.

Możesz użyć consoledo wykonania niektórych z następujących zadań:

  • Utwórz licznik czasu, aby pomóc w prostym testowaniu porównawczym
  • Wyprowadź tabelę, aby wyświetlić tablicę lub obiekt w łatwym do odczytania formacie
  • Zastosuj kolory i inne opcje stylizacji do wyjścia za pomocą CSS

Obiekt konsoli

consoleObiekt daje dostęp do konsoli przeglądarki. Umożliwia wyświetlanie ciągów, tablic i obiektów, które pomagają debugować kod. consoleStanowi część windowobiektu, a dostarczany jest przez model obiektowy przeglądarki (BOM).

Dostęp do niego możemy uzyskać na consolejeden z dwóch sposobów:

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

Druga opcja jest w zasadzie odniesieniem do pierwszej, więc użyjemy drugiej do zapisania naciśnięć klawiszy.

Jedna krótka uwaga na temat BOM: nie ma ustalonego standardu, więc każda przeglądarka implementuje go w nieco inny sposób. Przetestowałem wszystkie moje przykłady zarówno w przeglądarce Chrome, jak i Firefox, ale dane wyjściowe mogą wyglądać inaczej w zależności od przeglądarki.

Wyprowadzanie tekstu

Najczęstszym elementem consoleobiektu jest console.log. W większości scenariuszy użyjesz go do wykonania zadania.

Istnieją cztery różne sposoby wysyłania wiadomości do konsoli:

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

Wszystkie cztery działają w ten sam sposób. Wszystko, co musisz zrobić, to przekazać jeden lub więcej argumentów do wybranej metody. Następnie wyświetla inną ikonę wskazującą poziom rejestrowania. W poniższych przykładach można zobaczyć różnicę między dziennikiem poziomu informacyjnego a dziennikiem na poziomie ostrzeżeń / błędów.

Być może zauważyłeś komunikat dziennika błędów - jest bardziej efektowny niż inne. Wyświetla zarówno czerwone tło, jak i ślad stosu, gdzie infoi warn nie. Chociaż warnma żółte tło w Chrome.

Te różnice wizualne są pomocne, gdy trzeba szybko zidentyfikować jakiekolwiek błędy lub ostrzeżenia w konsoli. Chciałbyś się upewnić, że są one usuwane z aplikacji gotowych do produkcji, chyba że są tam, aby ostrzec innych programistów, że robią coś nie tak z twoim kodem.

Podstawienia ciągów

Ta technika używa symbolu zastępczego w ciągu, który jest zastępowany przez inne argumenty przekazane do metody. Na przykład:

Wejście :console.log('string %s', 'substitutions')

Wyjście :string substitutions

To %ssymbol zastępczy dla drugiego argumentu, 'substitutions'który znajduje się po przecinku. Wszelkie ciągi, liczby całkowite lub tablice zostaną przekonwertowane na ciąg i zastąpią rozszerzenie %s. Jeśli przekażesz obiekt, zostanie wyświetlony [object Object].

Jeśli chcesz przekazać obiekt, musisz użyć %olub %Ozamiast %s.

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

Liczby

Zastępowanie ciągów może być używane z liczbami całkowitymi i wartościami zmiennoprzecinkowymi przy użyciu:

  • %ilub %ddla liczb całkowitych,
  • %f dla zmiennoprzecinkowych.

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

Wyjście :int: 1, floating-point: 1.500000

Liczba zmiennoprzecinkowa może być sformatowana tak, aby wyświetlała tylko jedną cyfrę po przecinku przy użyciu %.1f. Możesz zrobić, %.nfaby wyświetlić liczbę n cyfr po przecinku.

Gdybyśmy sformatowali powyższy przykład, aby wyświetlić jedną cyfrę po przecinku dla liczby zmiennoprzecinkowej, wyglądałoby to tak:

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

Wyjście :int: 1, floating-point: 1.5

Specyfikatory formatowania

  1. %s| zastępuje element ciągiem
  2. %(d|i)| zastępuje element liczbą całkowitą
  3. %f | zastępuje element pływakiem
  4. %(o|O)| element jest wyświetlany jako obiekt.
  5. %c| Stosuje dostarczony CSS

Szablony ciągów

Wraz z pojawieniem się ES6, literały szablonów są alternatywą dla podstawień lub konkatenacji. Używają odwrotnych apostrofów (``) zamiast cudzysłowów, a zmienne trafiają do środka ${}:

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

Obiekty są wyświetlane tak jak [object Object]w literałach szablonów, więc musisz użyć podstawienia z %olub, %Oaby zobaczyć szczegóły, lub zarejestrować je osobno.

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.