new AbstractExport(q)
Base class for all export formats.
Concrete exporters implement AbstractExport#makeText; make wraps
text outputs into UTF-8 buffers for file writing.
Parameters:
| Name | Type | Description |
|---|---|---|
q |
object | Export declaration object. |
Properties:
| Name | Type | Description |
|---|---|---|
filepath |
string | Base output filepath. |
spaceFilter |
string | Regular expression used to select namespaces. |
Members
requireConcrete
Whether the exporter requires concrete namespaces only.
Methods
make() → {Array.<object>}
Creates buffer export outputs ready for file writing.
Returns:
Buffer outputs with content, pathSuffix, and type.
- Type
- Array.<object>
makeText() → {Array.<object>}
Creates text export outputs.
Returns:
Text outputs with content, pathSuffix, and type.
- Type
- Array.<object>
renderTemplate(name, data) → {string}
Renders a named template from the builder runtime.
Parameters:
| Name | Type | Description |
|---|---|---|
name |
string | Template filename. |
data |
object | Template render context. |
Returns:
Rendered template output.
- Type
- string
selectedNamespaces() → {Array.<Array>}
Selects namespaces matching spaceFilter.
Returns:
Pairs of [spaceName, namespace].
- Type
- Array.<Array>
(static) isValid(q, logger) → {boolean}
Validates an export declaration.
Parameters:
| Name | Type | Description |
|---|---|---|
q |
object | Export declaration object. |
logger |
Logger | Logger used for validation errors. |
Returns:
true when valid.
- Type
- boolean