req.param()
指定された名前のパラメータの値を返します。
req.param(name[, defaultValue]);
req.param()
は、リクエストの URL パス、ボディ、クエリ文字列 (この順序で) から指定されたパラメータを検索します。指定された name
を持つパラメータ値がリクエストのどこにも存在しない場合、undefined
を返すか、オプションの defaultValue
が指定されている場合はそれを返します。
req.params
)/foo/:id
へのリクエスト "/foo/4" は、URL パスパラメータ { id: 4 }
を持ちます。req.body
)req.query
){ email: 5 }
を持ちます。次のコードを持つカスタムアクションまたはポリシーを指すルート (POST /product/:sku
) を考えてみましょう。
req.param('sku');
// -> 123
次のいずれかの方法で sku
パラメータを送信することで、期待される結果を得ることができます。
POST /product/123
POST /product?sku=123
POST /product
{ "sku": 123 }
- 優先順位の順序は、URL パスパラメータがリクエストボディパラメータを上書きし、それがクエリ文字列パラメータを上書きすることを意味します。
- すべてのソース (URL パス、クエリ文字列、および解析されたリクエストボディを含む) からすべてのパラメータを取得したい場合は、
req.allParams()
を使用できます。