DocumentCollatorFactory

Home > @backstage/plugin-search-common > DocumentCollatorFactory

Factory class for instantiating collators.

Signature:

export interface DocumentCollatorFactory 

Properties

Property	Modifiers	Type	Description
type	readonly	string	The type or name of the document set returned by this collator. Used as an index name by Search Engines.
visibilityPermission?	readonly	Permission	(Optional) The Permission that controls visibility of resources associated with this collator's documents.

Methods

Method	Description
getCollator()	Instantiates and resolves a document collator.