This AI is still in early stages of development.
Check.provide()
- Aubergine
Owned by Aubergine
Indicate a file is now available.
Syntax
Check.provide(sdo);
Parameters
| Parameter | Type | Mandatory | Notes | API Version |
|---|---|---|---|---|
| sdo | Self Descriptor Object |  | The SDO describing the file and it's version. | 1.0 |
Return Values
| Value | Type | Notes | Util.js version |
|---|---|---|---|
| true | Boolean | Indicates the file was successfully marked as provided. | 1.0 |
| <error> | Error | An error occurred, most likely:
| 1.0 |
Example
Providing an API defined in a sandbox
void (function ProcessAPI(){
var self = {
file: "Process.js",
ver : 0.3
}
var dependencies = {
"Util.js": 0.9,
"Diag.js": 0.1
}
Check.required(dependencies, self);
// rest of your code
Check.provide(self);
})();
Contents
Jump to:
Dependency Checking
Topics:
- Tricks for including files — Some tricks with the include() function...
- Dependency Descriptor Object — Define one or more dependencies for your script...
- Check() — Perform a soft-check to see if a dependency is available...
- Check.basePath — The base path to the folder that contains the APIs folder...
- Check.paths[] — Define one or more folder paths to enable autoloading...
- Check.doWhen() — Perform a task when dependencies become available.
- Check.has() — Check if a dependency is available, try and load it if not, return availability state...
- Check.LAZY_LOAD — Disable autoloading during a dependency check...
- Check.required() — Thrown a descriptive error if dependency check fails...
- Check.NOT_LOADED — Indicates a script is not yet loaded, or must not be loaded, depending on the Check function being used...
- Check.ANY_VERSION — Skip version checking for a dependency check...
- Check.provide() — Indicate a file is now available.
- Check.versionOf() — Check the version of a dependency.
- Self Descriptor Object — Define the filename and version of your script...