Node.js Util モジュールのいくつかの便利な関数

Node.js には、JavaScript ランタイム環境を形成するために連携するさまざまなコンポーネントが含まれています。 Node.js アーキテクチャ - Node.js の概要に関するシリーズでは、Node.js を構成するさまざまなコンポーネントとそれぞれの機能について説明しました。

Node.js 内には、多数の組み込みモジュール、つまり最初から統合されているモジュールがあります。そのようなモジュールの 1 つは util ですが、私の意見では、これはもっと注目に値します。 util モジュールは、特定の状況で役立つ小さなユーティリティ関数のコレクションで構成されています。この記事では、これらの機能のいくつかについて詳しく説明します...

util.promisify と util.callbackify

コールバックは、非同期コードを処理する最も初期の方法の 1 つです。ただし、コールバックには、ネストされたコードが作成され、悪名高い「コールバック地獄」が引き起こされるなど、いくつかの制限があります。場合によっては、コールバック スタイルで記述されたコードを読むのに圧倒されることがあります。新しい機能を追加するには、追加のロジック層を導入する必要があるため、困難な場合があります。

Node.js には、コールバック スタイルを使用した非同期関数を Promises に変換するユーティリティ関数があります。この関数は、Promise ベースのアプローチに移行し、それを async/await と組み合わせてコードをより簡潔にして理解しやすくする場合に便利です。

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(); 

逆に、Promise ベースの関数をコールバックに変換する util.callbackify があります。

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

ライブラリを頻繁に使用する場合は、関数が非推奨であることを示すコンソール メッセージに気付いたかもしれません。

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

これは、oldFunction のサポート ライフサイクルが終わりに近づいており、将来削除される可能性があるという通知です。関数が「廃止」に近づいていることを開発者に通知し、代わりに代替関数を使用するのが一般的なアプローチです。

Node.js では、関数のサポート終了が近づいていることを他の人に警告する必要がある場合に、この通知を表示する簡単な方法があります。

const util = require('util');

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

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

oldFunction を util.deprecate 内に「ラップ」するだけです。 oldFunction が呼び出されるたびに、警告メッセージがコンソールに表示されます。

util.types

ES6 以降、データの型 (ブール値、配列、オブジェクトなど) をチェックする追加関数があります。

util モジュールには、データ型をチェックする機能を拡張する types プロパティがあります。

例:

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

包括的なリストは、util.types | で入手できます。 Node.js ドキュメント。

util.isDeepStrictEqual

isDeepStrictEqual は、2 つのオブジェクトを比較し、それらが同一であるかどうかを判断する最も効率的なメソッドです。

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

これらの関数に加えて、util モジュールは、コンソールのテキスト出力をフォーマットする util.styleText や .env ファイル内の環境変数の内容を解析する util.parseEnv など、他の多くのユーティリティ関数を提供します。

詳細については、以下を参照してください:

• Node.js v22.8.0 ドキュメント |使用量

以上がNode.js Util モジュールのいくつかの便利な関数の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。