PublisherBase.getReadiness()

Home > @backstage/plugin-techdocs-node > PublisherBase > getReadiness

Check if the publisher is ready. This check tries to perform certain checks to see if the publisher is configured correctly and can be used to publish or read documentations. The different implementations might e.g. use the provided service credentials to access the target or check if a folder/bucket is available.

Signature:

getReadiness(): Promise<ReadinessResponse>;

Returns:

Promise<ReadinessResponse>