CapacitorHttp
Capacitor Http APIは、fetchとXMLHttpRequestをネイティブライブラリを使用するようにパッチすることでネイティブのHTTPサポートを提供します。fetchやXMLHttpRequestを使用せずにネイティブHTTPリクエストを行うためのヘルパーメソッドも提供します。このプラグインは@capacitor/coreにバンドルされています。
設定
デフォルトでは、window.fetchとXMLHttpRequestをネイティブライブラリを使用するようにパッチする機能は無効になっています。
この機能を有効にしたい場合は、capacitor.configファイルで以下の設定を変更してください。
| プロパティ | 型 | 説明 | デフォルト |
|---|---|---|---|
enabled | boolean | fetchとXMLHttpRequestをネイティブライブラリを使用するようにパッチする機能を有効にします。 | false |
設定例
capacitor.config.jsonでの設定:
{
"plugins": {
"CapacitorHttp": {
"enabled": true
}
}
}
capacitor.config.tsでの設定:
import { CapacitorConfig } from '@capacitor/cli';
const config: CapacitorConfig = {
plugins: {
CapacitorHttp: {
enabled: true,
},
},
};
export default config;
Example
import { CapacitorHttp } from '@capacitor/core';
// Example of a GET request
const doGet = () => {
const options = {
url: 'https://example.com/my/api',
headers: { 'X-Fake-Header': 'Fake-Value' },
params: { size: 'XL' },
};
const response: HttpResponse = await CapacitorHttp.get(options);
// or...
// const response = await CapacitorHttp.request({ ...options, method: 'GET' })
};
// Example of a POST request. Note: data
// can be passed as a raw JS Object (must be JSON serializable)
const doPost = () => {
const options = {
url: 'https://example.com/my/api',
headers: { 'X-Fake-Header': 'Fake-Value' },
data: { foo: 'bar' },
};
const response: HttpResponse = await CapacitorHttp.post(options);
// or...
// const response = await CapacitorHttp.request({ ...options, method: 'POST' })
};