api report

Signed-off-by: Vincenzo Scamporlino <vincenzos@spotify.com>
This commit is contained in:
Vincenzo Scamporlino
2023-08-02 14:13:58 +02:00
committed by Philipp Hugenroth
parent cc9256a33b
commit 97f21bce47
2 changed files with 39 additions and 2 deletions
@@ -0,0 +1,27 @@
## API Report File for "@backstage/backend-plugin-api"
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
// @alpha (undocumented)
export interface FeatureDiscoveryService {
// (undocumented)
getBackendFeatures(): Promise<{
features: Array<BackendFeature>;
}>;
}
// Warning: (ae-forgotten-export) The symbol "ServiceRef" needs to be exported by the entry point alpha.d.ts
//
// @alpha
export const featureDiscoveryServiceRef: ServiceRef<
FeatureDiscoveryService,
'plugin'
>;
// Warnings were encountered during analysis:
//
// src/alpha.d.ts:5:9 - (ae-forgotten-export) The symbol "BackendFeature" needs to be exported by the entry point alpha.d.ts
// (No @packageDocumentation comment for this package)
```
+12 -2
View File
@@ -21,6 +21,16 @@ export interface BackendFeature {
$$type: '@backstage/BackendFeature';
}
// @public (undocumented)
export interface BackendFeatureFactory<
TOptions extends [options?: object] = [],
> {
// (undocumented)
$$type: '@backstage/BackendFeatureFactory';
// (undocumented)
(...options: TOptions): BackendFeature;
}
// @public
export interface BackendModuleConfig {
moduleId: string;
@@ -116,12 +126,12 @@ export namespace coreServices {
// @public
export function createBackendModule<TOptions extends [options?: object] = []>(
config: BackendModuleConfig | ((...params: TOptions) => BackendModuleConfig),
): (...params: TOptions) => BackendFeature;
): BackendFeatureFactory<TOptions>;
// @public
export function createBackendPlugin<TOptions extends [options?: object] = []>(
config: BackendPluginConfig | ((...params: TOptions) => BackendPluginConfig),
): (...params: TOptions) => BackendFeature;
): BackendFeatureFactory<TOptions>;
// @public
export function createExtensionPoint<T>(