Interface UseReferralReturn

Interface representing the return object of the useReferral hook.

Hierarchy

  • UseReferralReturn

Properties

fetched referees referrer refresh

Properties

fetched

fetched: boolean

A boolean indicating whether the referral data has been fetched.

referees

referees: Referee[]

The fetched referees data.

referrer

referrer: null | Referrer

The fetched referrer data, or null if not yet fetched.

refresh

refresh: ((quiet?) => void)

Type declaration

    • (quiet?): void

    • A method to manually refresh the referral data.

      Parameters

      • Optional quiet: boolean

      Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc