Configurable Interface
An item which can be configured (evaluated) against a composed configuration to produce a result.
This API is provided as an alpha preview and may change without notice.
For more information about our API support guarantees, see here.
Signature
interface Configurable<TConfigPartial, out TResult, TComponent>
Type Parameters
| Parameter | Description |
|---|---|
| TConfigPartial | The configuration type made available when configuring. |
| TResult | The result produced by configuring. |
| TComponent | The content components contribute. |
Remarks
Use getConfigured(configurable) to evaluate a Configurable. The result is cached, so a given Configurable is only evaluated once per composition.
Methods
| Method | Alerts | Return Type | Description |
|---|---|---|---|
| configure(config, components) | Alpha | TResult | Produce the configured result. |
Method Details
configure
Produce the configured result.
This API is provided as an alpha preview and may change without notice.
For more information about our API support guarantees, see here.
Signature
configure(config: TConfigPartial, components: Composed<TComponent, TConfigPartial>): TResult;
Parameters
| Parameter | Type | Description |
|---|---|---|
| config | TConfigPartial | The composed configuration. |
| components | Composed<TComponent, TConfigPartial> | The composed components. |
Returns
Return type: TResult