錯誤碼
查閱 gResultCode 的分組與使用慣例。
穩定的錯誤碼定義在 src/errors.ts。0 一律表示成功,負數則依領域分組:
| 範圍 | 領域 |
|---|---|
-1 至 -99 | 通用錯誤 |
-100 至 -199 | 網路 |
-200 至 -299 | 基礎設施 |
-300 至 -399 | 電子郵件 |
-1000 至 -1199 | 使用者驗證與帳號 |
-2000 至 -2099 | 流量限制與風險控管 |
-3000 至 -3299 | OAuth 用戶端與 OAuth 2.0 伺服器 |
-4000 至 -4099 | SaaS 設定與執行錯誤 |
-5000 至 -5099 | 付款 |
-6000 至 -6099 | 帳號設定與安全性操作 |
-7000 至 -7099 | 客服案件 |
-8000 至 -8099 | 清單查詢 |
-9000 至 -9099 | 造訪統計 |
-10000 至 -10099 | 範本發布 |
-11000 至 -11099 | Newsletter |
-12000 至 -12099 | 聯盟行銷 |
-13000 至 -13099 | 站內通知 |
這裡列出的是原始碼中的錯誤碼分組,不代表每個分組都有對應的已開放 API。例如,保留範本發布錯誤碼,不表示初始化後的專案已提供範本分發介面。
錯誤碼表達程式可判斷的原因,HTTP 狀態碼表達傳輸結果,在地化的 error 索引鍵則負責使用者文案。三者不能互相取代。新增錯誤碼時只能追加,不能重複使用已發布的數值來表達另一種含義。