console.tap
v0.5.0
Published
The missing logging function for modern Javascript, v => ( console.log( v ), v )
Downloads
24
Maintainers
Readme
v => (console.log(v), v);
logTap
provides a logging function that does not interrupt your existing code. The function takes in a value, logs the value, then returns the value.
In addition to the standalone logTap
function, this module provides:
- a standalone copy of the
console
object that includes thetap
along with antap
for each existingconsole
function ( e.g.console.warn.tap
,console.error.tap
) - a polyfill that replaces the regular console with the standalone copy
- a babel macro
I believe that logTap
should be a part of the standard spec, and as such I will be referring to it as console.tap
going forward.
You can click here to jump to the API
You can view the slides and notes for my lighting talk proposing console.tap
at Tap Talk Presentation
Why
Javascript has become an Expression dominated language. Which means just about everything we do results in a value. This allows us to write more concise code where one thing leads cleanly into the next.
For Example:
const userID = getUserId(
JSON.parse(localStorage.getItem("user"))
);
const pickAndFormatData = ({ date, amount }) => ({
date: moment(date).format("DD/MM/YYY "),
amount: Number(amount) ? formatCurrency(amount) : amount
});
const result = arr
.map(parseNumbers)
.filter(removeOdds)
.reduce(average);
But there is no console
function that fit in this modern style. Instead console.log
and it's like return undefined
.
Which means you will have to awkwardly break up the code to debug it.
console.tap
solves the undefined
issue. It takes in a value, logs the value, then returns the value.
For comparison:
With console.log
:
const userStr = localStorage.getItem("user");
console.log(userStr);
const userID = getUserId(JSON.parse(userStr));
With console.tap
:
const user = JSON.parse(
console.tap(localStorage.getItem("user"))
);
With console.log
:
const pickAndFormatData = ({ date, amount }) => {
console.log(amount, Number(amount));
const result = {
date: moment(date).format("DD/MM/YYY "),
amount: Number(amount) ? formatCurrency(amount) : amount
};
console.log(result);
return result;
};
With console.tap
:
const pickAndFormatData = ({ date, amount }) =>
console.tap({
date: moment(console.tap(date)).format("DD/MM/YYY"),
amount: console.tap(Number(amount))
? formatCurrency(amount)
: amount
});
With console.log
:
const filtered = arr.map(parseNumbers).filter(removeOdds);
console.log(filtered);
const result = filtered.reduce(average);
With console.tap
:
const result = console.tap(arr
.map(parseNumbers)
.filter(removeOdds))
.reduce(average);
Why Tap
In functional programing tap
is a function with the signature (a → *) → a → a
.
It takes a function and a value, calls the function with the value, ignores the result and returns the value.
console.tap
is tap
with console.log
baked in.
Examples
API
logTap( value, [options] )
Takes in a value, logs the value, then returns the value.
Developer consoles cannot accurately display the file name and line numbers for logTap
calls since they pull that information based on where where the console.log
is called. To make up for that logTap
takes an optional second parameter that serves as an tapifying label for the call.
Arguments
value (*)
: The value that will be logged and then returned.[options] (*|TapOptions)
:
*
: Any value that will be logged preceding the value
as a label.
TapOptions (object)
:
label (string)
: a value that will be logged preceding the value
as a label.
lineNumber (boolean)
: a flag to indicate if the function should add the line number where the function is being called from to the label
Example
import { logTap } from "console.tap";
fetch(url)
.then(res => res.json)
.then(console.tap)
.then(dispatchRecivedData);
import { logTap } from "console.tap";
const filterOptionsByInputText = ({
options,
filterText
}) =>
options.filter(value =>
logTap(value.contains(filterText), value)
);
Console
A standalone copy of the console
object that includes the tap
along with an tap
for each existing console
function ( e.g. console.warn.tap
, console.error.tap
)
Each console._.tap
works like the standard tap.
This is offered as a ponyfill alternative to the polyfill.
import cs from "console.tap";
const SuggestionList = ({ options, filterText }) => (
<ul>
{options
.filter(value =>
cs.tap(value.contains(filterText), {
label: `${filterText} ${value}`,
lineNumber: true
})
)
.map(value => (
<li key={value}>{value}</li>
))}
</ul>
);
import cs from "console.tap";
try {
const user = JSON.parse(
console.group.tap(localStorage.getItem("user"))
);
} catch ( e ) {
return console.error.tap( e )
}
Polyfill
If you’d really like to embrace tap
, you can use the polyfill by adding import "console.tap/dist-src/polyfill.js”;
which will add console.tap
and add tap
options to each existing console
function.
Example
import "console.tap/dist-src/polyfill.js";
const value = console.tap("anything");
const warning = console.warn.tap("anything");