Class: XhrLoader<T>
Abstract base class for implementing custom resource loaders. The loaders should override the
createResource
method and return a custom resource derived from LoaderResource
.
Loaders should be added to the xhrLoaders
array via registerXhrLoaders
from which the
loading process will try every one in order until a proper resource is returned.
The derived classes have protected static access to loader internals getLoadResources
and
loadResource
which can be used to load resource dependencies.
Type parameters
Name | Type |
---|---|
T |
extends LoaderResource = LoaderResource |
Constructors
constructor
• new XhrLoader<T
>(): XhrLoader
<T
>
Type parameters
Name | Type |
---|---|
T |
extends LoaderResource = LoaderResource |
Returns
XhrLoader
<T
>
Properties
getLoadResources
▪ Static
Protected
getLoadResources: (resources
: Resource
| Resource
[], dependencies
: boolean
) => Resource
[] = getLoadResources
Type declaration
▸ (resources
, dependencies?
): Resource
[]
Collect an array of unique resources with normalized paths from a resource list (or a single resource). Resources that are already completed are not added to the list but pending resources are.
Optionally if the resources have dependencies in the bundle map information those files are also added to the list, as well as the bundles that the files reside in.
Parameters
Name | Type | Default value | Description |
---|---|---|---|
resources |
Resource | Resource [] |
undefined |
List of resources |
dependencies |
boolean |
false |
Enable to collect dependencies too |
Returns
Resource
[]
loadResource
▪ Static
Protected
loadResource: (request
: LoadRequest
) => Promise
<LoaderResource
> = loadResource
Type declaration
▸ (request
): Promise
<LoaderResource
>
Load and process a single resource. This will also wait for all dependencies to load.
Parameters
Name | Type | Description |
---|---|---|
request |
LoadRequest |
Request to load a resource with options |
Returns
Promise
<LoaderResource
>
Methods
createResource
▸ createResource(url
, extension
, result
, options?
, resourceOptions?
): Promise
<undefined
| T
>
Parameters
Name | Type |
---|---|
url |
string |
extension |
string |
result |
LoadSuccess |
options? |
LoadOptions |
resourceOptions? |
ResourceOptions |
Returns
Promise
<undefined
| T
>