Constructor
new TJSConverter(cascadeXmlPath)
- Source:
Create a converter
Parameters:
| Name | Type | Description |
|---|---|---|
cascadeXmlPath |
string | relative path to xml file |
Methods
convert() → {Promise}
- Source:
convert xml to classifier
Returns:
- Type
- Promise
getDocblock() → {string}
- Source:
get defined jsdoc comment
Returns:
- Type
- string
saveAsVJ(classifier, filepath) → {Promise}
- Source:
convert and saves classifier as tracking.js-ViolaJones js file
Parameters:
| Name | Type | Description |
|---|---|---|
classifier |
string | tracking.ViolaJones.classifiers.${classifier} |
filepath |
string | relative path for export |
Returns:
- Type
- Promise
setAuthor(author, email) → {TJSConverter}
- Source:
set jsdoc author
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
author |
string | ||
email |
string |
null
|
Returns:
- Type
- TJSConverter
setDescription(description) → {TJSConverter}
- Source:
set jsdoc description
Parameters:
| Name | Type | Description |
|---|---|---|
description |
string |
Returns:
- Type
- TJSConverter
setLicense(license) → {TJSConverter}
- Source:
set jsdoc license
Parameters:
| Name | Type | Description |
|---|---|---|
license |
string |
Returns:
- Type
- TJSConverter
setLink(link) → {TJSConverter}
- Source:
set jsdoc link
Parameters:
| Name | Type | Description |
|---|---|---|
link |
string | URL |
Returns:
- Type
- TJSConverter
setVersion(version) → {TJSConverter}
- Source:
set jsdoc version
Parameters:
| Name | Type | Description |
|---|---|---|
version |
string |
Returns:
- Type
- TJSConverter
toTjs(orig) → {Array}
- Source:
converter to tracking.js VJ
Parameters:
| Name | Type | Description |
|---|---|---|
orig |
object |
Returns:
- Type
- Array