Node.js v0.11.11 マニュアル & ドキュメンテーション

Index | View on single page | View as JSON

process

process#

process はグローバルオブジェクトで、どこからでもアクセスすることができます。それは EventEmitter のインスタンスです。

Exit Codes#

未完了の非同期な操作が無くなると、Node はステータスコード 0 で正常に終了します。その他のケースでは、以下のステータスコードが使われます。

1 捕捉されなかった致命的な例外 - 捕捉されなかった例外があり、それがドメインや uncaughtException イベントハンドラによって処理されなかった。
2 - 未使用 (Bashに組み込まれた誤用のために予約)。
3 内部的な JavaScript のパースエラー - Node がプロセスをブートストラップする内部用の JavaScript ソースコードでパースエラーが発生した。これはきわめてまれで、通常 Node 自身を開発している時にしか起こりません。
4 内部的な JavaScript の評価失敗 - Node がプロセスをブートストラップする内部用の JavaScript ソースコードが評価された際、関数を返すことに失敗した。これはきわめてまれで、通常 Node 自身を開発している時にしか起こりません。
5 致命的なエラー - 致命的で回復不可能なエラーが V8 で発生した。通常、標準エラー出力に接頭辞 FATAL ERROR とともにメッセージが出力されます。
6 内部的エラーハンドラが関数ではない - 捕捉されない例外が発生したが、内部的な例外ハンドラにどういうわけか関数ではないものが設定されていて呼び出せなかった。
7 内部的なエラーハンドラが実行時に失敗 - 捕捉されない例外が発生し、それを処理していた内部的な例外ハンドラ自身も例外をスローした。これはたとえば、process.on('uncaughtException') または domain.on('error') のハンドラが例外をスローした場合に発生します。
8 - 未使用。以前のバージョンの Node では、終了コード 8 は捕捉されない例外を示すことがありました。
9 不正な引数 - 未知のオプションが指定された、あるいは値が必須のオプションが値無しで指定された。
10 内部的な JavaScript の実行時失敗 - Node がプロセスをブートストラップする内部用の JavaScript ソースコードが評価された際、例外をスローした。これはきわめてまれで、通常 Node 自身を開発している時にしか起こりません。
12 不正なデバッグ引数 - --debug または --debug-brk が指定されたが、不正なポート番号が選ばれた。
>128 シグナルによる終了 - Node が SIGKILL や SIGHUP などの致命的なシグナルを受け取ると、終了コードは 128 にシグナルコードを加えた値になります。これは終了コードが 7bit 整数で定義された時からの Unix の標準的な慣習で、シグナルによる終了は最上位のビットを設定し、シグナルコードの値を含みます。

Event: 'exit'#

プロセスが終了しようとしている時に生成されます。この位置からイベントループを抜けることを防ぐ方法はなく、全ての 'exit' リスナーの実行が完了すると、プロセスは終了します。従って、このハンドラでできることは同期操作だけです。これは (ユニットテストのように) モジュールの状態をチェックするのに適したフックとなります。コールバックはプロセスの終了コードを唯一の引数として呼び出されます。

exit を監視する例:

process.on('exit', function(code) {
  // do *NOT* do this
  setTimeout(function() {
    console.log('This will not run');
  }, 0);
  console.log('About to exit with code:', code);
});

Event: 'uncaughtException'#

発生した例外がイベントループまでたどり着いた場合に生成されます。もしこの例外に対するリスナーが加えられていれば、デフォルトの動作 (それはスタックトレースをプリントして終了します) は起こりません。

uncaughtException を監視する例:

process.on('uncaughtException', function(err) {
  console.log('Caught exception: ' + err);
});

setTimeout(function() {
  console.log('This will still run.');
}, 500);

// Intentionally cause an exception, but don't catch it.
nonexistentFunc();
console.log('This will not run.');

uncaughtException は例外を扱うとても荒削りなメカニズムであることに注意してください。

これを使う代わりに、ドメインを使ってください。それを使えば、捕まえられない例外が発生した後でもアプリケーションを再開することができます！

これを Node.js における On Error Resume Next として 使わないで ください。捕まえられなかった例外は、アプリケーション - および Node.js 自身の拡張 - が未定義の状態となることを意味します。やみくもな再開は どんなことでも 起こることを意味します。

電源を引き抜きながらアプリケーションをアップグレードすることを想像してください。 10 回中 9 回は何も起こりません - しかし 10 回目にはそのシステムは使えなくなるかもしれません。

これは警告です。

Signal Events#

プロセスがシグナルを受信した場合に生成されます。 SIGINT、SIGHUP、その他の POSIX 標準シグナル名の一覧については sigaction(2) を参照してください。

SIGINTを監視する例:

// Start reading from stdin so we don't exit.
process.stdin.resume();

process.on('SIGINT', function() {
  console.log('Got SIGINT.  Press Control-D to exit.');
});

多くの端末プログラムで簡単に SIGINT を送る方法は Control-C を押すことです。

注意:

SIGUSR1 は Node.js がデバッガを起動するために予約されています。リスナを登録することは出来ますが、デバッガの起動を止めることは出来ません。
SIGTERM および SIGINT は、Windows 以外のプラットフォームでは 128 + シグナル番号で終了する前にターミナルのモードをリセットするデフォルトのハンドラを持ちます。これらのシグナルのどちらかにリスナが登録されると、デフォルトの振る舞いは削除されます (node は終了しなくなります)。
SIGPIPE はデフォルトでは無視され、リスナを登録することが出来ます。
SIGHUP は Windows ではコンソールウィンドウが閉じられると発生します。他のプラットフォームでも同様の条件で発生します。詳細は signal(7) を参照してください。リスナを登録することは出来ますが、Windows では約 10 秒後に node は無条件に Windows によって終了されます。 Windows 以外のプラットフォームでは、SIGHUP のデフォルトの振る舞いは nodeを終了することですが、リスナを登録するとデフォルトの振る舞いは削除されます。
SIGTERM は Windows ではサポートされません。しかし、リスナを登録することは可能です。
端末からの SIGINT は全てのプラットフォームでサポートされ、通常 CTRL+C (おそらく設定可能でしょう) によって生成されます。ターミナルが raw モードの場合は生成されません。
SIGBREAK は Windows において CTRL+BREAK が推された時に送られます。 Windows 以外のプラットフォームでもリスナを登録することは出来ますが、それを生成したり送信する方法はありません。
SIGWINCH はコンソールのサイズが変更された場合に送られます。 Windows では、カーソルが移動するか、tty が raw モードの場合に、コンソールへ書き込むと発生します。
SIGKILL のリスナを組み込むことは出来ません。それは全てのプラットフォームで node を無条件に終了します。
SIGSTOP のリスナを組み込むことは出来ません。

Windows はシグナルの送信をサポートしていませんが、nodeはprocess.kill() や child_process.kill() をエミュレートする方法を提供します:

シグナル 0 は既存のプロセスを検索するためのものです。
SIGINT、SIGTERM、そして SIGKILL は、ターゲットのプロセスが無条件に終了する原因となります。

process.stdout#

stdout に対する Writable Stream です。

例: console.log の定義

console.log = function(d) {
  process.stdout.write(d + '\n');
};

process.stderr と process.stdout は他のストリームと異なり、書き込みは通常ブロックします。それらが通常ファイルや TTY のファイル記述子を参照しているケースでは、それらはブロックします。パイプを参照しているケースでは、他のストリームと同様にブロックしません。

Node が TTY のコンテキストで実行されているかチェックするには、 process.stderr, process.stdout, または process.stdin の isTTY プロパティを参照します。

$ node -p "Boolean(process.stdin.isTTY)"
true
$ echo "foo" | node -p "Boolean(process.stdin.isTTY)"
false

$ node -p "Boolean(process.stdout.isTTY)"
true
$ node -p "Boolean(process.stdout.isTTY)" | cat
false

より詳細は the tty docs を参照してください。

process.stderr#

stderr に対する Writable Stream です。

process.stdin#

標準入力に対する Readable Stream です。デフォルトでは、標準入力に対するストリームは中断されているため、読み込みのためには process.stdin.resume() を呼び出さなければなりません。

標準入力をオープンして二つのイベントを監視する例:

process.stdin.resume();
process.stdin.setEncoding('utf8');

process.stdin.on('data', function(chunk) {
  process.stdout.write('data: ' + chunk);
});

process.stdin.on('end', function() {
  process.stdout.write('end');
});

process.argv#

コマンドライン引数を含む配列です。最初の要素は 'node'、2 番目の要素は JavaScript ファイルの名前になります。その後の要素はコマンドラインの追加の引数になります。

// print process.argv
process.argv.forEach(function(val, index, array) {
  console.log(index + ': ' + val);
});

このように出力されます:

$ node process-2.js one two=three four
0: node
1: /Users/mjr/work/node/process-2.js
2: one
3: two=three
4: four

process.execPath#

プロセスによって開始された実行可能ファイルの絶対パスです。

例:

/usr/local/bin/node

process.execArgv#

これはプロセス起動時に実行可能ファイルに与えられた node 固有のコマンドライン・オプション群です。それらのオプションは process.argv には現れず、node の実行可能ファイルやスクリプト名、スクリプト名に続くどんなオプションも含まれません。これらのオプションは親プロセスと同じ実行環境を持つ子プロセスを起動するために役に立ちます。

例:

$ node --harmony script.js --version

process.execArgv の結果:

['--harmony']

そして process.argv の結果:

['/usr/local/bin/node', 'script.js', '--version']

process.abort()#

これは node をアボートさせます。これは node が終了してコアファイルを生成する原因となります。

process.chdir(directory)#

プロセスのカレントワーキングディレクトリを変更します。もし失敗した場合は例外をスローします。

console.log('Starting directory: ' + process.cwd());
try {
  process.chdir('/tmp');
  console.log('New directory: ' + process.cwd());
}
catch (err) {
  console.log('chdir: ' + err);
}

process.cwd()#

プロセスのカレントワーキングディレクトリを返します。

console.log('Current directory: ' + process.cwd());

process.env#

ユーザの環境を含むオブジェクトです。environ(7) を参照してください。

process.exit([code])#

指定の code でプロセスを終了します。もし省略されると、「成功」を示すコード 0 を使って終了します。

「失敗」を示すコードで終了する例:

process.exit(1);

node を実行したシェルで終了コードが 1 であることを見ることができるでしょう。