LinkCheck

baja. LinkCheck

new LinkCheck(valid, reasonopt)

Description:

  • LinkCheck is the result of a call to baja.Component#checkLink.
    It stores information about a link's validity, and if the LinkCheck
    is invalid then it stores the reason.

Source:
Parameters:
Name Type Attributes Description
valid boolean
reason String <optional>

Methods

getInvalidReason() → {String}

Description:

  • Returns the reason a LinkCheck is invalid.

Source:
Returns:

the reason the LinkCheck is invalid.

Type
String

isValid() → {boolean}

Description:

  • Indicates the validity of the LinkCheck

Source:
Returns:

true if the LinkCheck is valid

Type
boolean

(static) makeInvalid(invalidReason) → {baja.LinkCheck}

Description:

  • Make a LinkCheck indicating an invalid link.
    This invalidReason should be localized for the Context passed to
    baja.Component#checkLink.

Source:
Parameters:
Name Type Description
invalidReason String
Returns:
Type
baja.LinkCheck

(static) makeValid() → {baja.LinkCheck}

Description:

  • Make a LinkCheck indicating a valid link.

Source:
Returns:
Type
baja.LinkCheck

Type Definitions

LinkCreateInfo

Source:
Properties:
Name Type Description
source baja.Component

the source component to set on the BLink
sourceSlot baja.Slot | string

the source slot to set on the BLink
target baja.Component

the target component to set on the BLink
targetSlot baja.Slot | string

the target slot to set on the BLink