DX5 メソッド

canonicalize

dextuploadx5-react 0.0.1 以降
説明

与えられたパスをブラウザで使用可能な完全パスへ補正します。

グローバル dx5 オブジェクトが準備済みで dx5.canonicalize が存在する場合はそれをそのまま使用し、まだロード前であればブラウザ origin 基準の基本 URL 補正のみを行います。

パス値が空なら空文字列を返します。
形式
```
fullPath = DX5.canonicalize(path);
```
パラメータ

名前型説明

path String
補正する相対パスまたは絶対パス
戻り値
補正されたパス文字列

get

dextuploadx5-react 0.0.1 以降
説明

与えられた id に該当する X5 インスタンスオブジェクトを取得します。

グローバル dx5 がまだ準備されていない状態で呼び出すとエラーを発生させ、id が空なら null を返します。
形式
```
module = DX5.get(id);
```
パラメータ

名前型説明

id String
参照する X5 インスタンス id
戻り値
与えられた id に該当する X5 インスタンスオブジェクト。対象がない場合や id が空の場合は null になることがあります。

isLoaded

dextuploadx5-react 0.0.1 以降
説明

グローバル dx5 オブジェクトが現在準備済みかどうかを確認します。

DEXTUploadX5Provider が製品スクリプトの読み込みを完了したか判断する際に使用できます。
形式
```
loaded = DX5.isLoaded();
```
戻り値
グローバル dx5 オブジェクトが存在すれば true、そうでなければ false

raw

dextuploadx5-react 0.0.1 以降
説明

グローバル dx5 オブジェクト原本をそのまま返します。

React ラッパーが公開していない機能を直接使う必要がある場合の参照用途で使用できます。

グローバルオブジェクトがまだ準備されていない場合は null を返します。
形式
```
globalDX5 = DX5.raw();
```
戻り値
グローバル dx5 オブジェクトまたは null