A Few Useful Functions in Node.js Util Module

A Few Useful Functions in Node.js Util Module

Daily short news for you
  • Privacy Guides is a non-profit project aimed at providing users with insights into privacy rights, while also recommending best practices or tools to help reclaim privacy in the world of the Internet.

    There are many great articles here, and I will take the example of three concepts that are often confused or misrepresented: Privacy, Security, and Anonymity. While many people who oppose privacy argue that a person does not need privacy if they have 'nothing to hide.' 'This is a dangerous misconception, as it creates the impression that those who demand privacy must be deviant, criminal, or wrongdoers.' - Why Privacy Matters.

    » Read more
  • There is a wonderful place to learn, or if you're stuck in the thought that there's nothing left to learn, then the comments over at Hacker News are just for you.

    Y Combinator - the company behind Hacker News focuses on venture capital investments for startups in Silicon Valley, so it’s no surprise that there are many brilliant minds commenting here. But their casual discussions provide us with keywords that can open up many new insights.

    Don't believe it? Just scroll a bit, click on a post that matches your interests, check out the comments, and don’t forget to grab a cup of coffee next to you ☕️

    » Read more
  • Just got played by my buddy Turso. The server suddenly crashed, and checking the logs revealed a lot of errors:

    Operation was blocked LibsqlError: PROXY_ERROR: error executing a request on the primary

    Suspicious, I went to the Turso admin panel and saw the statistics showing that I had executed over 500 million write commands!? At that moment, I was like, "What the heck? Am I being DDoSed? But there's no way I could have written 500 million."

    Turso offers users free monthly limits of 1 billion read requests and 25 million write requests, yet I had written over 500 million. Does that seem unreasonable to everyone? 😆. But the server was down, and should I really spend money to get it back online? Roughly calculating, 500M would cost about $500.

    After that, I went to the Discord channel seeking help, and very quickly someone came in to assist me, and just a few minutes later they informed me that the error was on their side and had restored the service for me. Truly, in the midst of misfortune, there’s good fortune; what I love most about this service is the quick support like this 🙏

    » Read more

The Issue

Node.js encompasses a range of components that come together to form a JavaScript runtime environment. In our series on Node.js Architecture - Introduction to Node.js, we explored the various components that make up Node.js and their respective functions.

Within Node.js, there are numerous built-in modules - i.e., modules that are integrated from the outset. One such module is util, which, in my opinion, deserves more attention. The util module comprises a collection of small utility functions that can be helpful in certain situations. In this article, we will delve into some of these functions...

util.promisify and util.callbackify

The callback is one of the earliest ways to handle asynchronous code. However, callbacks have several limitations, such as creating nested code and causing the infamous "callback hell." Occasionally, reading a piece of code written in a callback style can be overwhelming. Adding new functionality can be challenging, as it requires introducing an additional layer of logic.

In Node.js, there is a utility function to convert asynchronous functions using the callback style to Promises. This function is useful when you want to transition to a Promise-based approach and then combine it with async/await to make your code more concise and easier to follow.

const util = require('node:util');
const fs = require('node:fs');

const stat = util.promisify(fs.stat);

async function callStat() {
  const stats = await stat('.');
  console.log(`This directory is owned by ${stats.uid}`);
}

callStat(); 

Conversely, we have util.callbackify to convert Promise-based functions back to callbacks.

const util = require('node:util');

async function fn() {
  return 'hello world';
}
const callbackFunction = util.callbackify(fn);

callbackFunction((err, ret) => {
  if (err) throw err;
  console.log(ret);
}); 

util.deprecate

If you frequently use libraries, you may have noticed console messages indicating that a function is deprecated.

oldFunction() is deprecated. Use newFunction() instead.

This is a notification that the oldFunction is nearing the end of its support lifecycle and may be removed in the future. It is a common approach to remind developers that a function is approaching its "retirement" and to use an alternative function instead.

In Node.js, there is a simple way to display this notification if you need to warn others that a function is nearing its end-of-life.

const util = require('util');

function oldFunction() {
    console.log('This function is deprecated!');
}

const deprecatedFunction = util.deprecate(oldFunction, 'oldFunction() is deprecated. Use newFunction() instead.');

Simply "wrap" the oldFunction inside util.deprecate. Each time oldFunction is called, the warning message will appear in the console.

util.types

From ES6 onward, we have additional functions to check the type of data: boolean, array, object, etc.

The util module has a types property that extends the capability to check data types.

For instance:

console.log(util.types.isPromise(Promise.resolve())); // true
console.log(util.types.isRegExp(/abc/)); // true
console.log(util.types.isDate(new Date())); // true

A comprehensive list is available at util.types | Node.js documentation.

util.isDeepStrictEqual

isDeepStrictEqual is the most efficient method to compare two objects and determine if they are identical.

const util = require('util');

const obj1 = { a: 1, b: { c: 2 } };
const obj2 = { a: 1, b: { c: 2 } };

console.log(util.isDeepStrictEqual(obj1, obj2)); // true

In addition to these functions, the util module provides many other utility functions, such as util.styleText to format text output in the console, and util.parseEnv to parse the contents of environment variables in .env files.

For more information, refer to:

Premium
Hello

Me & the desire to "play with words"

Have you tried writing? And then failed or not satisfied? At 2coffee.dev we have had a hard time with writing. Don't be discouraged, because now we have a way to help you. Click to become a member now!

Have you tried writing? And then failed or not satisfied? At 2coffee.dev we have had a hard time with writing. Don't be discouraged, because now we have a way to help you. Click to become a member now!

View all

Subscribe to receive new article notifications

or
* The summary newsletter is sent every 1-2 weeks, cancel anytime.

Comments (0)

Leave a comment...