simplify the module argument

Signed-off-by: Fredrik Adelöw <freben@gmail.com>
This commit is contained in:
Fredrik Adelöw
2023-08-09 10:58:29 +02:00
parent 8fe998a868
commit b98f508543
2 changed files with 12 additions and 11 deletions
@@ -4,7 +4,7 @@
```ts
import { BackendFeature } from '@backstage/backend-plugin-api';
import { DefaultCatalogCollatorFactoryOptions } from '@backstage/plugin-search-backend-module-catalog';
import { CatalogCollatorEntityTransformer } from '@backstage/plugin-search-backend-module-catalog';
// @alpha
export const searchModuleCatalogCollator: (
@@ -12,10 +12,9 @@ export const searchModuleCatalogCollator: (
) => BackendFeature;
// @alpha
export type SearchModuleCatalogCollatorOptions = Pick<
DefaultCatalogCollatorFactoryOptions,
'entityTransformer'
>;
export type SearchModuleCatalogCollatorOptions = {
entityTransformer?: CatalogCollatorEntityTransformer;
};
// (No @packageDocumentation comment for this package)
```
@@ -25,8 +25,8 @@ import {
} from '@backstage/backend-plugin-api';
import { catalogServiceRef } from '@backstage/plugin-catalog-node/alpha';
import {
CatalogCollatorEntityTransformer,
DefaultCatalogCollatorFactory,
DefaultCatalogCollatorFactoryOptions,
} from '@backstage/plugin-search-backend-module-catalog';
import { searchIndexRegistryExtensionPoint } from '@backstage/plugin-search-backend-node/alpha';
import { readScheduleConfigOptions } from './collators/config';
@@ -36,10 +36,12 @@ import { readScheduleConfigOptions } from './collators/config';
*
* @alpha
*/
export type SearchModuleCatalogCollatorOptions = Pick<
DefaultCatalogCollatorFactoryOptions,
'entityTransformer'
>;
export type SearchModuleCatalogCollatorOptions = {
/**
* Allows you to customize how entities are shaped into documents.
*/
entityTransformer?: CatalogCollatorEntityTransformer;
};
/**
* Search backend module for the Catalog index.
@@ -73,7 +75,7 @@ export const searchModuleCatalogCollator = createBackendModule(
readScheduleConfigOptions(config),
),
factory: DefaultCatalogCollatorFactory.fromConfig(config, {
...options,
entityTransformer: options?.entityTransformer,
discovery,
tokenManager,
catalogClient: catalog,