io.sailsオブジェクト
概要
io.sailsオブジェクトは、sails.io.jsライブラリとその作成するすべてのソケットに関するグローバルな設定オプションの格納場所です。io.sailsのプロパティのほとんどは、クライアントソケットをサーバーに接続する際のsettingsとして、またはクライアントライブラリ自体の最上位設定として使用されます。io.sailsは、新しいソケット接続を手動で作成するために使用される.connect()メソッドも提供します。
io.sailsの設定方法については、Socket クライアントを参照してください。
.connect()メソッド
io.sails.autoConnectがfalseの場合、またはsails.io.jsライブラリで複数のソケット接続を作成する必要がある場合、io.sails.connect([url], [options])を使用して作成します。両方の引数はオプションであり、io.sailsのプロパティ（url、transportsなど）の値がデフォルトとして使用されます。オプションについては、SailsSocket プロパティリファレンスを参照してください。
io.sails.autoConnect
io.sails.autoConnectがtrue（デフォルト設定）に設定されている場合、ライブラリはロード後にイベントループの1サイクルを待ってから、新しいSailsSocketを作成し、io.sails.urlで指定されたURLに接続しようとします。ブラウザで使用する場合、新しいソケットはio.socketとして公開されます。Node.jsスクリプトで使用する場合、新しいソケットはsails.io.jsライブラリを初期化するために使用された変数のsocketプロパティとして添付されます。
io.sails.reconnection
io.sails.reconnectionがtrueに設定されている場合、ソケットは予期せず切断された場合（つまり、.disconnect()の呼び出しの結果ではない場合）、自動的に（そして継続的に）サーバーへの再接続を試みます。false（デフォルト）に設定されている場合、自動的な再接続の試行は行われません。デフォルトはfalseです。
io.sails.environment
io.sails.environmentを使用して、sails.io.jsの環境を設定します。これは、コンソールにログ出力される情報の量に影響します。有効な値はdevelopment（完全なログ）とproduction（最小限のログ）です。
その他のプロパティとデフォルト値
io.sailsの他のプロパティは、新しいソケット（eager socketまたはio.sails.connect()経由）を作成する際のデフォルト値として使用されます。利用可能なオプションの完全なリストと、デフォルトのio.sails値の表については、SailsSocket プロパティリファレンスを参照してください。最も一般的に使用されるプロパティを以下に示します。
| プロパティ | 型 | デフォルト | 詳細 |
|---|---|---|---|
| url | io.sails.urlの値 |
ソケットが接続している、または接続しようとしているURL。 | |
| transports | io.sails.transportsの値 |
ソケットが接続を試みるトランスポート。トランスポートは順番に試され、アップグレードが許可されます。つまり、「polling」と「websocket」の両方をリストした場合、ロングポーリング接続を確立した後、サーバーはそれをwebsocket接続にアップグレードしようとします。この設定は、Sailsアプリのsails.config.sockets.transportsの値と一致する必要があります。 |
|
| headers | io.sails.headersの値 |
このソケットからのすべてのリクエストでデフォルトで送信されるヘッダーの辞書。 .request()のheadersオプションで上書きできます。 |
sailsjs.comでより良い体験をするには、ブラウザをアップデートしてください。
リファレンス
- アプリケーション
- ブループリントAPI
- コマンドラインインターフェース
-
設定
- sails.config.*
- sails.config.blueprints
- sails.config.bootstrap()
- sails.config.custom
- sails.config.datastores
- sails.config.globals
- sails.config.http
- sails.config.i18n
- sails.config.log
- sails.config.models
- sails.config.policies
- sails.config.routes
- sails.config.security
- sails.config.session
- sails.config.sockets
- sails.config.views
-
リクエスト (`req`)
- req._startTime
- req.body
- req.cookies
- req.fresh
- req.headers
- req.hostname
- req.ip
- req.ips
- req.isSocket
- req.method
- req.options
- req.originalUrl
- req.params
- req.path
- req.protocol
- req.query
- req.secure
- req.signedCookies
- req.socket
- req.subdomains
- req.url
- req.wantsJSON
- req.xhr
- req.accepts()
- req.acceptsCharsets()
- req.acceptsLanguages()
- req.allParams()
- req.file()
- req.get()
- req.is()
- req.param()
- req.setLocale()
- req.setTimeout()
- req.host
- レスポンス (`res`)
- Waterline (ORM)
- WebSockets
リファレンス
愛情込めて作成
Sailsフレームワークは、テキサス州オースティンにあるウェブ＆モバイルショップによって、貢献者たちの協力を得て構築されました。私たちは2012年にNode.jsプロジェクトを支援するためにSailsを作成しました。当然のことながら、オープンソース化しました。皆さんの生活を少しでも楽にできれば幸いです！
© 2012-2024 The Sails Company.
Sailsフレームワークは、MITライセンスの下で無料でオープンソースです。
イラストレーション：Edamame.