Skip to content

Commit

Permalink
doc: document relationships between time() and timeEnd()
Browse files Browse the repository at this point in the history
`console.time()` and `console.timeEnd()` are very closely related. It's
useful to reference them both from each other.

Previously, console.time() did not mention that it needed to be paired
with a call to console.timeEnd() to be useful, and timeEnd() also failed
to mention that console.time() needed to be called first.

References in both directions have been added.
  • Loading branch information
markstos committed Dec 23, 2014
1 parent 00a7456 commit 00c7942
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions doc/api/console.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -64,11 +64,19 @@ Defaults to `false`. Colors are customizable, see below.

## console.time(label)

Mark a time.
Used to calculate the duration of a specific operation. To start a timer, call
the `console.time()` method, giving it a name as only parameter. To stop the
timer, and to get the elapsed time in miliseconds, just call the
[`console.timeEnd()`](#console_console_timeend_label) method, again passing the
timer's name as the parameter.

## console.timeEnd(label)

Finish timer, record output. Example:
Stops a timer that was previously started by calling
[`console.time()`](#console_console_time_label) and print the result to the
console.

Example:

console.time('100-elements');
for (var i = 0; i < 100; i++) {
Expand Down

0 comments on commit 00c7942

Please sign in to comment.