Skip to main content
Version: Next

RegisterCollatorParameters

Home > @backstage/plugin-search-backend-node > RegisterCollatorParameters

Parameters required to register a collator.

Signature:

export interface RegisterCollatorParameters 

Properties

Property

Modifiers

Type

Description

factory

DocumentCollatorFactory

The class responsible for returning the document collator of the given type.

schedule

SchedulerServiceTaskRunner

The schedule for which the provided collator will be called, commonly the result of SchedulerService.createScheduledTaskRunner()