Skip to main content
Version: Next

TechDocsCollatorFactoryOptions

Home > @backstage/plugin-search-backend-module-techdocs > TechDocsCollatorFactoryOptions

Warning: This API is now obsolete.

This type is deprecated along with the DefaultTechDocsCollatorFactory.

Options to configure the TechDocs collator factory

Signature:

export type TechDocsCollatorFactoryOptions = {
discovery: DiscoveryService;
logger: LoggerService;
tokenManager?: TokenManager;
auth?: AuthService;
httpAuth?: HttpAuthService;
locationTemplate?: string;
catalogClient?: CatalogApi;
parallelismLimit?: number;
legacyPathCasing?: boolean;
entityTransformer?: TechDocsCollatorEntityTransformer;
};

References: DiscoveryService, LoggerService, AuthService, HttpAuthService, CatalogApi, TechDocsCollatorEntityTransformer