@backstage/plugin-tech-insights-node
Home > @backstage/plugin-tech-insights-node
Interfaces
Interface | Description |
---|---|
FactChecker | FactChecker interface A generic interface that can be implemented to create checkers for specific check and check return types. This is used especially when creating Scorecards and displaying results of rules when run against facts. |
FactCheckerFactory | A factory wrapper to construct FactChecker implementations. |
FactRetriever | FactRetriever interface |
FactRetrieverRegistry | |
TechInsightCheck | Generic definition of a check for Tech Insights |
TechInsightCheckRegistry | Registry containing checks for tech insights. |
TechInsightsFactCheckerFactoryExtensionPoint | |
TechInsightsFactRetrieverRegistryExtensionPoint | |
TechInsightsFactRetrieversExtensionPoint | |
TechInsightsPersistenceContextExtensionPoint | |
TechInsightsStore | TechInsights Database |
Variables
Variable | Description |
---|---|
techInsightsFactCheckerFactoryExtensionPoint | An extension point that allows other plugins or modules to set a FactCheckerFactory. |
techInsightsFactRetrieverRegistryExtensionPoint | An extension point that allows other plugins or modules to set a custom FactRetrieverRegistry. |
techInsightsFactRetrieversExtensionPoint | An extension point that allows other plugins or modules to add fact retrievers. |
techInsightsPersistenceContextExtensionPoint | An extension point that allows other plugins or modules to set a custom PersistenceContext. |
Type Aliases
Type Alias | Description |
---|---|
CheckValidationResponse | Validation response from CheckValidator May contain additional data for display purposes |
FactLifecycle | A fact lifecycle definition. Determines which strategy to use to purge expired facts from the database. |
FactRetrieverContext | FactRetrieverContext injected into individual handler methods of FactRetriever implementations. The context can be used to construct logic to retrieve entities, contact integration points and fetch and calculate fact values from external sources. |
FactRetrieverRegistration | Registration of a fact retriever Used to add and schedule individual fact retrievers to the fact retriever engine. |
FactSchemaDefinition | A flat serializable structure for Facts. Containing information about fact schema, version, id, and entity filters |
FlatTechInsightFact | Response type used when returning from database and API. Adds a field for ref for easier usage |
MaxItems | A maximum number for items to be kept in the database for each fact retriever/entity pair |
PersistenceContext | A Container for persistence related components in TechInsights |
TechInsightFact | A container for facts. The shape of the fact records needs to correspond to the FactSchema with same Container may contain multiple individual facts and their values |
TTL | A Luxon duration like object for time to live value |