Interface DocumentCollatorFactory

Factory class for instantiating collators.

interface DocumentCollatorFactory {
    type: string;
    visibilityPermission?: Permission;
    getCollator(): Promise<Readable>;
}

Implemented by

Index

Properties

type visibilityPermission?

Methods

Properties

`Readonly`type

type: string

The type or name of the document set returned by this collator. Used as an index name by Search Engines.

`Optional` `Readonly`visibilityPermission

visibilityPermission?: Permission

The @backstage/plugin-permission-common#Permission that controls visibility of resources associated with this collator's documents.

Methods

getCollator

getCollator(): Promise<Readable>
Instantiates and resolves a document collator.

Returns Promise<Readable>
- Defined in plugins/search-common/src/types.ts:189