UseCreditsResult
UseCreditsResult =
object
Defined in: src/react/useCredits.ts:39
Properties
balance
balance:
HandlersCreditBalanceResponse|null
Defined in: src/react/useCredits.ts:43
Current credit balance and related info
claimDailyCredits()
claimDailyCredits: () =>
Promise<HandlersClaimDailyCreditsResponse|null>
Defined in: src/react/useCredits.ts:68
Claim free daily credits (once per 24 hours)
Returns
Promise<HandlersClaimDailyCreditsResponse | null>
The claim response or null on error
error
error:
Error|null
Defined in: src/react/useCredits.ts:55
Error from the last operation
fetchPacks()
fetchPacks: () =>
Promise<void>
Defined in: src/react/useCredits.ts:63
Fetch available credit packs
Returns
Promise<void>
isLoading
isLoading:
boolean
Defined in: src/react/useCredits.ts:51
Whether any operation is in progress
packs
packs:
HandlersCreditPack[]
Defined in: src/react/useCredits.ts:47
Available credit packs for purchase
purchaseCredits()
purchaseCredits: (
credits:number,options?:object) =>Promise<string|null>
Defined in: src/react/useCredits.ts:74
Create a Stripe checkout session for purchasing a credit pack
Parameters
| Parameter | Type | Description |
|---|---|---|
|
|
|
Number of credits to purchase |
|
|
|
‐ |
|
|
|
‐ |
|
|
|
‐ |
Returns
Promise<string | null>
The checkout URL or null on error
refetch()
refetch: () =>
Promise<void>
Defined in: src/react/useCredits.ts:59
Refetch the credit balance
Returns
Promise<void>