Skip to main content

Interface: VerseDecoratorDescriptor

Defined in: Extensions/ExtensionApiDtos.ts:178

Properties

decorateEndpoint

decorateEndpoint: string

Defined in: Extensions/ExtensionApiDtos.ts:181

Reverse-RPC endpoint: (verseId[]) -> DecorationDto[].


id

id: string

Defined in: Extensions/ExtensionApiDtos.ts:179


invalidateOn?

optional invalidateOn?: ("verse.activeChanged" | "theme.changed" | "settings.changed" | "manual")[]

Defined in: Extensions/ExtensionApiDtos.ts:185

When the decorator should rebuild.


visibleVersesOnly?

optional visibleVersesOnly?: boolean

Defined in: Extensions/ExtensionApiDtos.ts:183

If true, the host calls decorateEndpoint for visible verses only. Default true.