Skip to content

PluginApiRef.unavailabilityReason

PluginApiRef › unavailabilityReason

Type: null | PluginApiUnavailabilityReason

Why the API is not available right now, or null while it is.

Classified at the moment of reading, by the same probe PluginApiRef.whenAvailable uses for its error, so a caller that must decide synchronously — which message to show, which button to offer — can tell "not installed" from "too old" without waiting for a timeout. Like PluginApiRef.value, it describes now: during a consumer's onload a provider that has not loaded yet reads as PluginApiUnavailabilityReason.NotPublished.