2.2.0 • Published 5 years ago
@bb-cli/portal-model v2.2.0
@bb-cli/portal-model : object
Load And Manipulate Model Xml Data
Example
import { fromXml, name }from '@bb-cli/portal-model';
console.log(`name is ${name(fromXml(fs.readFileSync('model.xml')))}`);
- @bb-cli/portal-model : object
- ~type(model) ⇒ string
- ~fromXml(xml) ⇒ object
- ~toXml(model) ⇒ string
- ~name(model) ⇒ string
- ~getPropertyValue(name, model) ⇒ string
- ~setProperty(propertyName, value, options, model) ⇒ object
- ~deleteProperty(propertyName, model) ⇒ object
@bb-cli/portal-model~type(model) ⇒ string
Extract catalog type from XML object.
Kind: inner method of @bb-cli/portal-model
Param | Type |
---|---|
model | object |
@bb-cli/portal-model~fromXml(xml) ⇒ object
Convert XML string to JS representation (using jxon).
Kind: inner method of @bb-cli/portal-model
Param | Type | Description |
---|---|---|
xml | string | Model xml |
@bb-cli/portal-model~toXml(model) ⇒ string
Convert js object to XML
Kind: inner method of @bb-cli/portal-model
Returns: string - model XML
Param | Type | Description |
---|---|---|
model | object | XML object |
@bb-cli/portal-model~name(model) ⇒ string
Extract name from XML object.
Kind: inner method of @bb-cli/portal-model
Param | Type |
---|---|
model | object |
@bb-cli/portal-model~getPropertyValue(name, model) ⇒ string
Get the value of a property.
Kind: inner method of @bb-cli/portal-model
Param | Type |
---|---|
name | string |
model | object |
@bb-cli/portal-model~setProperty(propertyName, value, options, model) ⇒ object
Set the value & options of a property.
Kind: inner method of @bb-cli/portal-model
Returns: object - Updated model
Param | Type |
---|---|
propertyName | string |
value | string |
options | object |
model | object |
@bb-cli/portal-model~deleteProperty(propertyName, model) ⇒ object
Delete a property.
Kind: inner method of @bb-cli/portal-model
Returns: object - Updated model
Param | Type |
---|---|
propertyName | string |
model | object |