Node.jsのurlObject.auth()メソッドの使い方を解説

Node.jsのurlObject.auth()プロパティは、URLに含まれるユーザー名とパスワードの部分(いわゆるuserInfo)を取得するための機能です。ユーザー名とパスワードは、コロン(:)で区切られた文字列として表現されます。

構文

urlObject.auth()

パラメータ

このメソッドは、URLからユーザー名とパスワードの情報を取得するだけのため、入力パラメータは必要ありません。

使用例1

まず、auth.jsという名前のファイルを作成し、以下のコードをコピーしてください。ファイル作成後、次のコマンドを実行してコードを動かしてみましょう。

node auth.js

auth.js

// URLモジュールをインポート
const url = require('url');

var adr = 'https://username=hello:password=tutorialspoint@www.tutorialspoint.com/';

// 上記のURLアドレスを解析
var q = url.parse(adr, true);

// 認証情報を出力
console.log(q.auth);

出力結果

C:\home\node>> node auth.js
username=hello:password=tutorialspoint

使用例2

続いて、別の例を見てみましょう。URLに含まれる認証情報が異なる場合でも、同様の方法で取得できることが確認できます。

// URLモジュールをインポート
const url = require('url');

var adr = 'https://username=admin:password=tutorialspoint123@www.tutorialspoint.com/';

// 上記のURLアドレスを解析
var q = url.parse(adr, true);

// 認証情報を出力
console.log(q.auth);

出力結果

C:\home\node>> node auth.js
username=admin:password=tutorialspoint123

このように、url.parse()メソッドでURLを解析したオブジェクトのauthプロパティを参照するだけで、URLに埋め込まれた認証情報を簡単に取得できます。なお、authプロパティは認証情報がURLに含まれていない場合はnullを返すため、実際の開発では存在チェックを行うことが推奨されます。