Interface VoucherManager

Readonlysize

create

• create(
      options?: {
          expiresInMs?: number;
          maxUses?: number;
          note?: string;
          payload?: Record<string, unknown>;
      },
  ): { code: string; expiresAt: number }

  Parameters

  • Optionaloptions: {
        expiresInMs?: number;
        maxUses?: number;
        note?: string;
        payload?: Record<string, unknown>;
    }

  Returns { code: string; expiresAt: number }

createMany

• createMany(
      count: number,
      options?: {
          expiresInMs?: number;
          maxUses?: number;
          note?: string;
          payload?: Record<string, unknown>;
      },
  ): string[]

  Mint N codes with the same payload.

  Parameters

  • count: number
  • Optionaloptions: {
        expiresInMs?: number;
        maxUses?: number;
        note?: string;
        payload?: Record<string, unknown>;
    }

  Returns string[]

getInfo

• getInfo(
      code: string,
  ):
      | {
          code: string;
          expired: boolean;
          expiresAt: number;
          maxUses: number;
          note?: string;
          revoked: boolean;
          usesLeft: number;
      }
      | null

  Public info — never exposes the redeemer list.

  Parameters

  • code: string

  Returns
      | {
          code: string;
          expired: boolean;
          expiresAt: number;
          maxUses: number;
          note?: string;
          revoked: boolean;
          usesLeft: number;
      }
      | null

load

• load(snapshot: Record<string, unknown>): void

  Parameters

  • snapshot: Record<string, unknown>

  Returns void

onRedeem

• onRedeem(
      cb: (
          info: {
              code: string;
              payload: Record<string, unknown>;
              user: string;
              usesLeft: number;
          },
      ) => void,
  ): () => void

  Parameters

  • cb: (
        info: {
            code: string;
            payload: Record<string, unknown>;
            user: string;
            usesLeft: number;
        },
    ) => void

  Returns () => void

prune

• prune(): number

  Drop expired/exhausted/revoked codes.

  Returns number

redeem

• redeem(user: string, code: string): RedeemResult

  Never throws on user input.

  Parameters

  • user: string
  • code: string

  Returns RedeemResult

revoke

• revoke(code: string): boolean

  Parameters

  • code: string

  Returns boolean

toJSON

• toJSON(): Record<string, unknown>

  Returns Record<string, unknown>