(info) This AI is still in early stages of development.

Check.required()

Thrown a descriptive error if dependency check fails...

 

Syntax

Check.required(dependencies, sdo);

Parameters

ParameterTypeMandatoryNotesUtil.js version
dependenciesDependency Descriptor Object(tick)The dependencies required by your script.1.0
sdoSelf Descriptor Object(tick)

The SDO of your script.

The dependency check will fail if your script is already provided (to prevent double-loading the same script).

1.0

Return Values

ValueTypeNotesUtil.js version
trueBooleanAll dependency checks were successful.1.0
<error>Error

One or more dependency checks failed.

The error message is very descriptive and should allow easy debugging.

1.0

Example

Checking dependencies in a sandbox
void (function ProcessAPI(){
	// https://warzone.atlassian.net/wiki/display/EGG/Self+Descriptor+Object
	var self = {
		file: "Process.js",
		ver : 0.3
	}
	
	// https://warzone.atlassian.net/wiki/display/EGG/Dependency+Descriptor+Object
	var dependencies = {
		"Util.js": Check.ANY_VERSION,
		"Diag.js": 0.1
	}
	
	Check.required(dependencies, self);
 
    // rest of your code
 
    Check.provide(self); // only gets called if no errors above
})();
Availability BETA

Requires:

Contents

Jump to:

Dependency Checking

Topics: