weapp.request
1.0.0
WeChat アプレット用に提供される wx.request 拡張子に基づくネットワーク リクエスト コンポーネント ライブラリ。
npm install weapp.request -S
const request = require ( 'weapp.request' )
GETリクエストを送信する
request ( 'https://api.github.com' ) . then ( onFulfilled ) . catch ( onRejected )
すべてのrequest
呼び出しはPromise
を返すため、 then
使用してリクエスト結果をさらに処理し、 catch
使用して内部的にスローされたエラーをキャプチャできます。
GETリクエストを送信してキャッシュに書き込みます
request ( 'https://api.github.com' , { } , {
cache : true
} )
POSTリクエストを送信する
request . post ( 'https://api.github.com' , {
user : 'afishhhhh'
} )
GET リクエストを除き、他のすべてのメソッドはrequest.method
の形式で呼び出す必要があります。
WeChat 公式ドキュメントによると、上記の POST メソッドとデフォルトのContent-Type
はapplication/json
で、データは JSON シリアル化されます。
データをクエリ文字列の形式でサーバーに送信する必要がある場合は、次の呼び出しメソッドを使用できます。Content Content-Type
application/x-www-form-urlencoded
として明示的に記述する必要はありません。
request . post ( 'https://api.github.com' , {
form : {
user : 'afishhhhh'
}
} )
グローバル構成
構成オプション | タイプ | 説明する | 必須 | デフォルト値 |
---|---|---|---|---|
ベースURL | String/Undefined | 基本的なリクエストパス | いいえ | |
キャッシュ最大年齢 | Number/Undefined | キャッシュの有効期間、時間単位は秒です | いいえ | 1800 |
有効ステータスコード | Function/Undefined | ステータス コードの有効範囲。この関数は 1 つのパラメータを受け入れ、 Boolean を返します。 | いいえ | code => code >= 200 && code < 300 |
request . config ( {
baseUrl : 'https://api.github.com'
} )
リクエスト/レスポンスインターセプタ
// 添加请求拦截器
request.interceptors.req.use(function (request) {
request.header['X-Tag'] = 'weapp.request'
// return request 可以显式地返回一个 request,如果没有 return,则默认返回当前 request
})
応答インターセプターについても同様です。
// 移除请求拦截器
request.interceptors.req.remove()
request(url, params, options)
GET リクエストを実行します。
params
: リクエストパラメータ、タイプはObject
、オプション。
options
: 構成アイテム、タイプはObject
、オプションで、次の属性値を持つことができます。
財産 | タイプ | 必須 | デフォルト値 | 説明する |
---|---|---|---|---|
キャッシュ | Boolean/Undefined | いいえ | undefined | undefined 、サーバーから最新のデータを取得し、キャッシュに書き込まないことを意味します。true true 、データがキャッシュに存在しない場合、またはキャッシュの有効期限が切れている場合、データを最初に取得することを意味します。 false 、最初にサーバーからデータを取得してキャッシュにデータを書き込むことを意味します。 |
ヘッダ | WeChat公式文書と同じ | |||
データタイプ | WeChat公式文書と同じ | |||
応答タイプ | WeChat公式文書と同じ |
request.method(url, params, options)
method
get
、 post
などです。
request.config(options)
options
: 構成項目、タイプはObject
です。
このコードは、MIT ライセンスの利用規約に基づいて配布されます。