Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
Excerpt

Perform a soft-check to see if a dependency is available...

 

Syntax

Code Block
themeRDark
languagejavascript
linenumberstrue
var available = Check(file, ver);

Parameters

ParameterTypeMandatoryNotesAPI Version
file

String

Array of String

(tick)

The name of the file to check, or an array of file names.File name should not include path - it should just be the name and extension of the file, for example: "foo.js"

Must match the value of the 'file' property specified in the Self Descriptor Object of the file you want to check.

If an array is passed in, all files will be checked for the same ver (if specified).

1.0
ver

Number

Constant

(error)

The version of the dependency, or one of the following constants:

Default: Check.ANY_VERSION

1.0

Return values

ValueTypeNotesAPI Version
trueBooleanThe specified requirements were met1.0
falseBooleanOne or more of the specified requirements was not met1.0

Notes

This function is similar to Check.has() with some notable differences:

  • Check() allows an array of filenames in the first parameter, Check.has() does not
  • Check() does not attempt to autoload missing files, Check.has() does (unless told not to)

Example

Code Block
themeRDark
languagejavascript
linenumberstrue
if (Check("foo.js")) {
  // do stuff that relies on foo.js (any version)
}
 
if (Check(["bar.js", "baz.js"], 1.2)) {
  // do stuff that requires v1.2 of bar.js and v1.2 of baz.js
}
 
if (Check("foo.js", Check.NOT_LOADED)) {
  // do stuff that relies on foo.js being unavailable
}
Div
classbox
Availability
Status
colourYellow
titleBeta

Requires:

Div
classbox
Contents

Jump to:

Table of Contents
maxLevel5

Div
classbox

Dependency Checking

Topics:

Child pages (Children Display)
alltrue
depthall
pageDependency Checking
excerpttrue