DX5 Methods

canonicalize

dextuploadx5-react 0.0.1 or later
Description

Normalizes the given path into a full path usable in the browser.

If the global dx5 object is ready and dx5.canonicalize exists, that implementation is used as-is. If it is still not loaded, only basic URL normalization relative to the browser origin is performed.

If the path value is empty, an empty string is returned.
Syntax
```
fullPath = DX5.canonicalize(path);
```
Parameters

Name Type Description

path String
The relative or absolute path to normalize
Return
The normalized path string

get

dextuploadx5-react 0.0.1 or later
Description

Gets the X5 instance object for the given id.

If called before the global dx5 object is ready, it throws an error. If the id is empty, it returns null.
Syntax
```
module = DX5.get(id);
```
Parameters

Name Type Description

id String
The id of the X5 instance to look up
Return
The X5 instance object for the given id. It can be null when the target does not exist or id is empty.

isLoaded

dextuploadx5-react 0.0.1 or later
Description

Checks whether the global dx5 object is currently ready.

This can be used to determine whether DEXTUploadX5Provider has completed loading the product script.
Syntax
```
loaded = DX5.isLoaded();
```
Return
true if the global dx5 object exists, otherwise false

raw

dextuploadx5-react 0.0.1 or later
Description

Returns the original global dx5 object as-is.

This can be used as a reference when you need to call functionality not exposed by the React wrapper.

If the global object is not ready yet, null is returned.
Syntax
```
globalDX5 = DX5.raw();
```
Return
The global dx5 object or null