@lzpenguin/economy
v1.0.9
Published
Riffle 经济系统客户端 SDK
Downloads
47
Readme
@lzpenguin/economy
Riffle economy client SDK for managing user coins and diamonds in games.
Installation
npm install @lzpenguin/economyQuick Start
import { RiffleEconomy } from '@lzpenguin/economy';
// Create an instance
const economy = new RiffleEconomy();
// Query account balance
const account = await economy.query();
console.log('Coins:', account.coin, 'Diamonds:', account.diamond);
// Consume currency (with error handling)
try {
const result = await economy.consume('coin', 10);
console.log('✅ Consumed successfully, remaining coins:', result.coin);
} catch (error) {
console.error('❌ Failed:', error.message);
}
API
new RiffleEconomy()
Create an instance
query()
Query account balance
- Returns:
Promise<{coin: number, diamond: number}>
consume(type, num)
Consume currency
type- currency type:'coin'or'diamond'num- amount (must be > 0)- Returns:
Promise<{coin: number, diamond: number}>
TypeScript
import { RiffleEconomy, CurrencyType, AccountInfo } from '@lzpenguin/economy';
const economy = new RiffleEconomy();
const account: AccountInfo = await economy.query();Common Errors
type must be "coin" or "diamond"- invalid currency typenum must be greater than 0- amount must be greater than 0Insufficient coin balance/Insufficient diamond balance- insufficient balance
License
ISC
