Saltar al contenido principal

Documentation Index

Fetch the complete documentation index at: https://docs.nippy.la/llms.txt

Use this file to discover all available pages before exploring further.

getState() consulta el estado de un usuario en una campaña antes de intentar girar.

Uso

const state = await nippy.getState({
  userId: 'user-123',
  campaignId: 'camp-abc'
})

Parámetros

userId
string
requerido
Identificador del usuario en tu sistema. Ejemplo: user-123.
campaignId
string
requerido
ID de la campaña. Ejemplo: camp-abc.

Respuesta

eligible
boolean
Indica si el usuario puede girar en este momento.
ineligibilityReason
string | null
Razón por la que el usuario no puede girar. Valores: cooldown_active, spin_limit_reached, campaign_ended o null.
spinsUsed
number
Cantidad de spins usados por el usuario en la campaña.
spinsAllowed
number
Cantidad máxima de spins permitidos. -1 indica spins ilimitados.
nextEligibleAt
string | null
Timestamp ISO 8601 en el que el usuario podrá girar de nuevo.
pendingClaim
object | null
Premio pendiente de reclamar, si existe.
pendingClaim.spinId
string
ID del spin asociado al claim pendiente.
pendingClaim.gift
object
Premio pendiente de reclamar.
pendingClaim.expiresAt
string
Fecha límite para reclamar el premio.