TechDocsStorageClient.syncEntityDocs()

Home > @backstage/plugin-techdocs > TechDocsStorageClient > syncEntityDocs

Check if docs are on the latest version and trigger rebuild if not

Signature:

syncEntityDocs(entityId: CompoundEntityRef, logHandler?: (line: string) => void): Promise<SyncResult>;

Parameters

Parameter	Type	Description
entityId	CompoundEntityRef	Object containing entity data like name, namespace, etc.
logHandler	(line: string) => void	(Optional) Callback to receive log messages from the build process

Returns:

Promise<SyncResult>

Whether documents are currently synchronized to newest version

Exceptions

Throws error on error from sync endpoint in TechDocs Backend