Table of Contents

AjaxUtil

概要

XMLHttpRequestを使用してAjaxリクエストを行う、ユーティリティークラスです。

メソッド

ajaxRequest(options)

型:XMLHttpRequest 非同期 Static

Ajaxリクエストを行います。

パラメータ

パラメータ説明
options.
必須
ObjectAjaxのオプションを指定します。以下のキーがあります。
URL
必須
StringアクセスするURLを指定します。
“method”
必須
StringHTTPメソッド(GET, POST, PUT等)を指定します。
“data”Object送信するデータを指定します。
“headers”Object送信するヘッダーを格納したオブジェクトです。それぞれの項目がXMLHttpRequestのsetRequestHeader()に渡されます。

戻り値

XHRオブジェクトを返します。

使用例

GET
let url = "https://api.example.com/members/1/"
let method = "GET";
 
BITSMIST.v1.AjaxUtil.ajaxRequest({url:url, method:method}).then((xhr) => {
    console.log(xhr.responseText);
});
POST
let url = "https://api.example.com/members/"
let method = "POST";
let item =  {"id":2, "name":"John"};
let headers = {
    "Content-Type":"application/json",
    "X-From": "www.example.com"
};
let options = {"withCredentials":true};
 
BITSMIST.v1.AjaxUtil.ajaxRequest({
    URL:url, 
    method:method, 
    data:item, 
    headers:headers, 
    options:options
}).then((xhr) => {
    console.log(xhr.responseText);
});

loadScript(url, options)

型:Undefined 非同期 Static

スクリプトファイルを指定されたURLからロードします。スクリプトは現在のページに挿入され、即時実行されます。

パラメータ

パラメータ説明
url
必須
StringスクリプトファイルのURLを指定します。
optionsStringオプションを指定します。以下のキーがあります。
“type”Stringスクリプトのタイプを指定します。scriptタグのtype属性として使用されます。

戻り値

なし。


loadJSON(url, options)

型:Object 非同期 Static

JSON/Javascriptオブジェクトファイルを指定されたURLからロードします。ロードされたファイルはJavascriptオブジェクトに変換されます。JSONかJavascriptオブジェクトかをoptionsパラメータで指定できます。フォーマットの指定がない場合、拡張子が“json”ならJSON, “js”ならJavascriptオブジェクトと判断されます。

パラメータ

パラメータ説明
url
必須
StringJSONファイルのURLを指定します。
optionsStringロードする際のオプションです。以下のキーがあります。
“format”Stringファイルのフォーマットです。“js”または“json”。

戻り値

取得したファイルを変換した、Javascriptオブジェクトです。


loadText(url)

型:String 非同期 Static

テキストファイルを指定されたURLからロードします。

パラメータ

パラメータ説明
url
必須
StringテキストファイルのURLを指定します。

戻り値

取得したファイルの中身のテキストです。


loadHTML(url)

型:String 非同期 Static

HTMLファイルを指定されたURLからロードします。

パラメータ

パラメータ説明
url
必須
StringHTMLファイルのURLを指定します。

戻り値

取得したファイルの中身のHTMLです。


loadCSS(url)

型:String 非同期 Static

CSSファイルを指定されたURLからロードします。

パラメータ

パラメータ説明
url
必須
StringCSSファイルのURLを指定します。

戻り値

取得したファイルの中身のCSSです。


loadClass(url, options)

型:Undefined 非同期 Static

クラスファイルをロードします。クラスファイルは現在のページに挿入され、即時実行されます。

引数のURLには拡張子をつけないでください。ライブラリが自動的に拡張子“.js”を付与して、ロードします。 “splitClass”オプションがTrueの場合、最初に“.js”、次に“.settings.js”の2つのファイルをロードします。

パラメータ

パラメータ説明
url
Required
StringクラスファイルのURLを指定します。拡張子は不要です。
optionsStringロードする際のオプションです。loadScript()関数に渡されます。

戻り値

なし。