TechDocsStorageApi.syncEntityDocs()

Home > @backstage/plugin-techdocs-react > TechDocsStorageApi > syncEntityDocs

Signature:

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

Parameters

Parameter	Type	Description
entityId	CompoundEntityRef
logHandler	(line: string) => void	(Optional)

**Returns:**

Promise<SyncResult>