Skip to content

UseCanResult

Result of useCan — the entitlement check reduced to the shape a can question actually needs.

can: boolean

true when the user may proceed. This is allowed || limited (equivalently, not denied): a limited entitlement still grants access — it just means the usage/credit balance is running low. Fail-open, matching the SDK: can is also true before the check resolves and if the entitlement service is unreachable. Gate on !can to block; never gate on !allowed (that would also block limited users who are still entitled).


limited: boolean

true when access is granted but the balance is approaching its limit (the “running low” state). Surface a soft warning while still allowing the action.


result: { } | null

The full entitlement result (status, reason, current_tier, placement, …), or null until the check resolves — the escape hatch for details beyond can / limited.