この機能はまだ実験段階です。
このメソッドはまだ開発中であり、そのインターフェースや動作は予告なく変更される可能性があります。
実行中のSailsインスタンスに仮想リクエストを行います。
sails.request(request);
または
sails.request(url, body)
sails.request(url, callback)
sails.request(url, body, callback)
このメソッドは、sails.load()
で起動されたが、サーバーポートでHTTPリクエストをアクティブにリッスンしていないインスタンスで使用できます。これにより、sails.lift()
の実行が不要なテストシナリオでsails.request()
が役立ちます。ただし、データはHTTPリクエストと全く同じ方法で処理されない可能性があることに注意が必要です。特に、より単純なボディパーサーが採用され、静的アセットサーバーなどのExpressミドルウェアは使用されません。
引数 | 型 | 詳細 | |
---|---|---|---|
1 | request (または url) | 作成する仮想リクエスト。文字列として指定した場合、オプションのメソッドとパスを含むアドレス(例:/foo やPUT /user/friend )である必要があります。オブジェクトとして指定した場合、「request 引数」セクションで説明されているプロパティを1つ以上持つ必要があります。 |
|
2 | body | (オプション) リクエストボディとして使用するJSONシリアライズ可能な値。この引数は、request 引数のdata プロパティが提供されている場合は、それを上書きします。 |
|
3 | callback | (オプション) 仮想レスポンスとともに呼び出されるコールバック。 |
request
引数がオブジェクトとして指定されている場合、以下のプロパティを持つことができます。
プロパティ | 型 | 例 | 詳細 |
---|---|---|---|
url | "/foo" , "PUT /user/friend" |
(必須) リクエストを送信するSailsアプリ内のルート。オプションでHTTPメソッドプレフィックス付き。 | |
method | "GET" , "POST" |
(オプション) リクエストで使用するHTTPメソッド。これは、url プロパティの一部として提供されたメソッドを上書きします。 |
|
headers | {'content-type': 'application/json'} |
(オプション) 仮想リクエストで使用するヘッダーの辞書。 | |
data | {foo:'bar'} , 12345 |
GET 、HEAD 、およびDELETE リクエストの場合、データはクエリ文字列にシリアライズされ、URLに追加されます。それ以外の場合は、リクエストボディとしてそのまま送信されます。 |
引数 | 型 | 詳細 | |
---|---|---|---|
1 | err | レスポンスが失敗した場合(ステータスコードが200〜399の範囲外の場合)、これはstatus とbody プロパティを含むオブジェクトになります。レスポンスが成功した場合はnull になります。 |
|
2 | response | レスポンスが成功した場合、これは完全なサーバーレスポンスを含むオブジェクトになります。 | |
3 | body | レスポンスが成功した場合、これはresponse.body の値になります。 |
型
完全な仮想リクエストストリームオブジェクト。これは読み取り可能なストリームです。