ElementBuilder

ElementBuilder

new ElementBuilder()

Source:

Class represents ElementBuilder

Methods

(private) _elementExists(name) → {boolean}

Source:

checks if element exists

Parameters:
Name Type Description
name ElementSignature.<name>
Returns:
Type
boolean

(private) _signatureExists(name) → {boolean}

Source:

checks if signature exists

Parameters:
Name Type Description
name ElementSignature.<name>
Returns:
Type
boolean

(private) _transformToObject(signatures) → {object}

Source:

transform signatures array to {name: signature} object

Parameters:
Name Type Description
signatures Array.<ElementSignature>
Returns:
Type
object

(private) _validate(elementName, data) → {boolean}

Source:

validate data against schema

Parameters:
Name Type Description
elementName ElementSignature.<name>
data *
Returns:
Type
boolean

addElement(name, schema, template, module) → {ElementBuilder}

Source:

adds element to registry

Parameters:
Name Type Description
name ElementSignature.<name>
schema object
template string
module ElementAbstract
Returns:
Type
ElementBuilder

(async) create(name, data) → {Promise}

Source:

loads dependency creates element by name and data

Parameters:
Name Type Description
name ElementSignature.<name>
data *
Returns:
Type
Promise

getElement(name) → {object|null}

Source:

get registered element

Parameters:
Name Type Description
name ElementSignature.<name>
Returns:
Type
object | null

getSchema(name) → {object}

Source:

get schema reference

Parameters:
Name Type Description
name ElementSignature.<name>
Returns:
Type
object

getSignature(name) → {object|null}

Source:

get signature

Parameters:
Name Type Description
name ElementSignature.<name>
Returns:
Type
object | null

getTemplateElement(template, data) → {Node}

Source:

get template element HTMLElement Node

Parameters:
Name Type Description
template string | function

Template string or render function

data *

data

Returns:
Type
Node

isBusySignature(name) → {boolean}

Source:

checks if signature is currently loading

Parameters:
Name Type Description
name ElementSignature.<name>
Returns:
Type
boolean

removeSignature(name) → {ElementBuilder}

Source:

remove signature from registry

Parameters:
Name Type Description
name ElementSignature.<name>
Returns:
Type
ElementBuilder

setBusySignature(name) → {ElementBuilder}

Source:

sets busy flag to

Parameters:
Name Type Description
name ElementSignature.<name>
Returns:
Type
ElementBuilder

ElementBuilder

new ElementBuilder(signatures, templateEngine, schemaValidator)

Source:

Create ElementBuilder instance

Parameters:
Name Type Description
signatures Array.<ElementSignature>
templateEngine function
schemaValidator function

Methods

(private) _elementExists(name) → {boolean}

Source:

checks if element exists

Parameters:
Name Type Description
name ElementSignature.<name>
Returns:
Type
boolean

(private) _signatureExists(name) → {boolean}

Source:

checks if signature exists

Parameters:
Name Type Description
name ElementSignature.<name>
Returns:
Type
boolean

(private) _transformToObject(signatures) → {object}

Source:

transform signatures array to {name: signature} object

Parameters:
Name Type Description
signatures Array.<ElementSignature>
Returns:
Type
object

(private) _validate(elementName, data) → {boolean}

Source:

validate data against schema

Parameters:
Name Type Description
elementName ElementSignature.<name>
data *
Returns:
Type
boolean

addElement(name, schema, template, module) → {ElementBuilder}

Source:

adds element to registry

Parameters:
Name Type Description
name ElementSignature.<name>
schema object
template string
module ElementAbstract
Returns:
Type
ElementBuilder

(async) create(name, data) → {Promise}

Source:

loads dependency creates element by name and data

Parameters:
Name Type Description
name ElementSignature.<name>
data *
Returns:
Type
Promise

getElement(name) → {object|null}

Source:

get registered element

Parameters:
Name Type Description
name ElementSignature.<name>
Returns:
Type
object | null

getSchema(name) → {object}

Source:

get schema reference

Parameters:
Name Type Description
name ElementSignature.<name>
Returns:
Type
object

getSignature(name) → {object|null}

Source:

get signature

Parameters:
Name Type Description
name ElementSignature.<name>
Returns:
Type
object | null

getTemplateElement(template, data) → {Node}

Source:

get template element HTMLElement Node

Parameters:
Name Type Description
template string | function

Template string or render function

data *

data

Returns:
Type
Node

isBusySignature(name) → {boolean}

Source:

checks if signature is currently loading

Parameters:
Name Type Description
name ElementSignature.<name>
Returns:
Type
boolean

removeSignature(name) → {ElementBuilder}

Source:

remove signature from registry

Parameters:
Name Type Description
name ElementSignature.<name>
Returns:
Type
ElementBuilder

setBusySignature(name) → {ElementBuilder}

Source:

sets busy flag to

Parameters:
Name Type Description
name ElementSignature.<name>
Returns:
Type
ElementBuilder