Interface CapabilityGenerator

interface CapabilityGenerator {
    generateCapability(
        config: CapabilityConfiguration,
    ): Promise<LayerArtifact>;
    getHumanLabel(): string;
    getIdentifier(): string;
    getLabel(): string;
    getType(): CapabilityType;
}

Hierarchy

CapabilityGeneratorMetadata
- CapabilityGenerator

Implemented by

BaseCapabilityGenerator

Index

Methods

generateCapability getHumanLabel getIdentifier getLabel getType

Methods

generateCapability

generateCapability(config: CapabilityConfiguration): Promise<LayerArtifact>
Parameters
- config: CapabilityConfiguration
Returns Promise<LayerArtifact>
- Defined in capabilities/capability-generator-interface.ts:79

getHumanLabel

getHumanLabel(): string
Returns string
Inherited from CapabilityGeneratorMetadata.getHumanLabel
- Defined in capabilities/capability-generator-interface.ts:18

getIdentifier

getIdentifier(): string
Returns string
Inherited from CapabilityGeneratorMetadata.getIdentifier
- Defined in capabilities/capability-generator-interface.ts:19

getLabel

getLabel(): string
Returns string
Inherited from CapabilityGeneratorMetadata.getLabel
- Defined in capabilities/capability-generator-interface.ts:17

getType

getType(): CapabilityType
Gets the type to indicate the type of capability being generated by the generator instance, which implements this interface. Currently, "collection" and "instance" values are supported.

Returns CapabilityType
Inherited from CapabilityGeneratorMetadata.getType
- Defined in capabilities/capability-generator-interface.ts:16