Node.js v0.11.11 マニュアル & ドキュメンテーション
Table of Contents
Global Objects#
これらのオブジェクトは全てのモジュールで有効です。 これらのオブジェクトのいくつかは実際はグローバルスコープではなくモジュールスコープです - 注意してください。
global#
- {Object} グローバルなネームスペースのオブジェクト
ブラウザでは、トップレベルのスコープはグローバルスコープです。
これは、ブラウザではグローバルスコープで var something
と定義するとグローバル変数になることを意味します。
Node では異なります。
トップレベルのスコープはグローバルスコープではありません;
Node のモジュール内での var something
はそのモジュールでローカルになります。
process#
- {Object}
プロセスオブジェクトです。process オブジェクト の節を参照してください。
console#
- {Object}
標準出力および標準エラー出力へのプリントに使われます。 コンソール を参照してください。
Class: Buffer#
- {Function}
バイナリデータを扱うために使われます。 バッファセクション を参照してください。
require()#
- {Function}
require モジュールを指します。モジュール の節を参照してください。
require
は実際はグローバルではなく、各モジュール毎のローカルです。
require.resolve()#
require()
の内部でモジュールの位置を検索するために使われます。
モジュールのロードは行わず、ファイル名を解決して返すだけです。
require.cache#
- Object
モジュールが要求されると、このオブジェクトの中にキャッシュされます。
このオブジェクトからキーと値を削除すると、次にそのモジュールが
require
されたときにリロードされます。
require.extensions#
Stability: 0 - Deprecated
- Object
require
にファイル拡張子を扱う方法を教えます。
拡張子が .sjs
であるファイルの処理を .js
と同じにするには:
require.extensions['.sjs'] = require.extensions['.js'];
廃止予定 かつて、このリストは非 JavaScript モジュールを必要に応じて コンパイルし、Node にロードするために使われていました。 しかし実際には、他の Node プログラムを通じてロードしたり、 事前に JavaScript にコンパイルするなど、よりよい方法があります。
モジュールシステムはロックされているので、この機能はおそらく 無くならないでしょう。 しかしながら、それは微妙なバグや複雑さがあってもそのまま放置されるでしょう。
__filename#
- {String}
実行されているコードのファイル名です。これは解決された絶対パスです。 メインプログラムでは、必ずしもコマンドライン引数で使われたファイル名と 同じではありません。 モジュールの中では、この値はそのモジュールファイルのパスとなります。
例: node example.js
を /Users/mjr
で実行する
console.log(__filename);
// /Users/mjr/example.js
__filename
は実際はグローバルではなく、各モジュール毎のローカルです。
__dirname#
- {String}
現在実行されているスクリプトが存在するディレクトリの名前です。
例: node example.js
を /Users/mjr
で実行する
console.log(__dirname);
// /Users/mjr
__dirname
は実際はグローバルではなく、各モジュール毎のローカルです。
module#
- {Object}
現在のモジュールへの参照です。
module.exports
は、モジュールが公開して require()
を通じて利用可能になる
ものを定めるために使われます。
module
は実際はグローバルではなく、各モジュール毎のローカルです。
より詳しくは モジュールシステムのドキュメント を参照してください。
exports#
module.exports
への参照です。
いつ exports
を使い、いつ module.exports
を使うかの詳細は
モジュールシステムのドキュメント を参照してください。
exports
は実際はグローバルではなく、各モジュール毎のローカルです。
より詳しくは モジュール を参照してください。
setTimeout(cb, ms)#
少なくとも ms
ミリ秒が経過した後、コールバック cb
を実行します。
実際の遅延は OS のタイマ分解能やシステムの負荷など外部要因に依存します。
タイムアウト値は 1~2,147,483,647 の範囲内でなければなりません。 もし値がこの範囲外だった場合は 1 ミリ秒となります。 大雑把に言って、タイマは 24.8 日を越えることはできません。
タイマを表現する不透明な値を返します。
clearTimeout(t)#
setTimeout()
によって以前に作成されたタイマを終了します。
コールバックは実行されなくなります。
setInterval(cb, ms)#
ms
ミリ秒ごとにコールバック cb
を繰り返し実行します。
OS のタイマ分解能やシステムの負荷など外部要因によって、
実際のインターバルが異なるかもしれないことに注意してください。
それは決して ms
より短いことはありませんが、より長いことがあります。
インターバル値は 1~2,147,483,647 の範囲内でなければなりません。 もし値がこの範囲外だった場合は 1 ミリ秒となります。 大雑把に言って、タイマは 24.8 日を越えることはできません。
タイマを表現する不透明な値を返します。
clearInterval(t)#
setInterval()
によって以前に作成されたタイマを終了します。
コールバックは実行されなくなります。
タイマー関数はグローバル変数です。タイマー を参照してください。