@qse/help-dialog

错误信息提示框

接入

import { HelpError } from '@qse/help-dialog'

// 设置用户信息
HelpError.defaults.personid = ''
HelpError.defaults.fgsid = ''
HelpError.defaults.studentid = ''
HelpError.defaults.campusid = ''

async function query() {
  const res = await fetch('/api/xx/xx')

  // 当 code !== '0' 时，创建 HelpError
  if (res.err_code !== '0') throw new HelpError(res)

  return res
}

全局捕获 HelpError

import { showHelpDialog } from '@qse/help-dialog'

function handleError(error: Error) {
  showHelpDialog(error)
}

导出对象说明

HelpError

函数签名

export declare class HelpError extends Error {
  info: HelpErrorInfo
  static defaults: HelpErrorInfo
  static isHelpError(error: Error): error is HelpError
  get isValid(): boolean
  constructor(info: HelpErrorInfo)
}

标准错误类，继承与 Error，可以当 Error 使用

通过 HelpError.defaults[xxx] 设置默认参数

通过 HelpError.isHelpError(error) 可以判断 error 是否是 HelpError

通过 error.isValid 判断 HelpError 是否具有合法参数（用于获取帮助信息）

showHelpDialog

函数签名

function showHelpDialog(error: Error): Promise<void>

传递 error 即可，内部会判断是否是合格的 HelpError，不合格显示 Dialog.alert({ content:error.message })，合格显示带有帮助的 dialog