xtraderClient/docs/api/mockData.md
2026-02-26 16:10:20 +08:00

42 lines
1.4 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# mockData.ts
**路径**`src/api/mockData.ts`
## 功能用途
模拟数据统一封装,集中管理事件、分类、订单簿、钱包等 mock 数据,配合 `src/config/mock.ts` 的开关使用。
## 导出内容
| 导出 | 类型 | 说明 |
|------|------|------|
| `MOCK_EVENT_LIST` | `PmEventListItem[]` | 模拟事件列表(来自 mockEventList |
| `MOCK_CATEGORY_TREE` | `CategoryTreeNode[]` | 模拟分类树(来自 category |
| `MOCK_ORDER_BOOK_ASKS` | `MockOrderBookRow[]` | 订单簿卖单 |
| `MOCK_ORDER_BOOK_BIDS` | `MockOrderBookRow[]` | 订单簿买单 |
| `MOCK_ORDER_BOOK_LAST_PRICE` | `number` | 最新价 |
| `MOCK_ORDER_BOOK_SPREAD` | `number` | 价差 |
| `MOCK_TOKEN_ID` | `string` | 测试用 token ID |
| `MOCK_WALLET_POSITIONS` | `MockPosition[]` | 钱包持仓 |
| `MOCK_WALLET_ORDERS` | `MockOpenOrder[]` | 钱包未成交订单 |
| `MOCK_WALLET_HISTORY` | `MockHistoryItem[]` | 钱包历史 |
| `getMockEventById(id)` | `(id: number) => PmEventListItem \| null` | 按 ID 获取 mock 事件 |
## 使用方式
```typescript
import { MOCK_WALLET_POSITIONS, getMockEventById } from '@/api/mockData'
import { USE_MOCK_WALLET } from '@/config/mock'
if (USE_MOCK_WALLET) {
positions.value = [...MOCK_WALLET_POSITIONS]
}
const fallback = getMockEventById(9001)
```
## 扩展方式
1. 新增 mock 数据:在 `mockData.ts` 中定义并导出
2. 修改现有数据:直接编辑对应常量