全局配置

全局配置位于项目根目录，global.config.ts, 在初始化文件中引入，如：main.ts、main.tsx、main.js、main.jsx 等

import { globalConfig } from "@finalx/common";

/**
 * @description: 全局初始化配置
 **/
globalConfig({
  log: true,
  request: {
    baseUrl: "https://api.finalx.cc",
    wsUrl: "wss://api.finalx.cc"
    wsCheckUser: true,
    wsEventKey: {
      eventKey: "event",
      dataKey: "data"
    }
  },
  middleware: {
    userAuth: {
      // filterKey: ["nickname", "avatar"]
      filterKey: ["nickname", { key: "avatar", rule: (val: any, key: string) => !!val[key] }]
    }
  }
});

属性

属性名	类型	默认值	必填	描述
log	boolean	-	否	是否输出工具内容到控制台
middleware	middlewareConfigType	-	否	中间件配置项
request	requestConfigType	-	否	请求实体配置项

middlewareConfigType 属性

属性名	类型	默认值	必填	描述
userAuth	middlewareAuthConfigType	-	否	用户鉴权权限
roleAuth	middlewareAuthConfigType	-	否	角色鉴权权限

middlewareAuthConfigType 属性

属性名	类型	默认值	必填	描述
data	Object | string	-	否	鉴权原始数据
filterKey	string | ({ key: string; rule?: (val: any, key: string) => boolean } | string)[]	-	否	鉴权字段或规则

requestConfigType 属性

属性名	类型	默认值	必填	描述
host	string	-	否	主机
path	string	-	否	路径
baseUrl	string	-	否	请求基础 URL
header	any	-	否	请求头
timeout	number	-	否	超时时间
bearerToken	boolean	-	否	是否添加 bearer 前缀
errorRule	requestErrorRuleConfigType	-	否	自定义请求错误规则
wsUrl	string	-	否	websocket 基础 URL
wsPing	boolean	-	否	是否开启 websocket 心跳机制
wsAck	boolean	-	否	是否签收 websocket 消息
wsCheckUser	boolean	-	否	是否校验 websocket 接收人
wsEventKey	requestWsKeyConfigType}	-	否	自定义 websocket 事件 key
wsOnInitSuccess	(res?: any) => any	-	否	websocket 初始化成功回调
wsOnInitFail	(res?: any) => any	-	否	websocket 初始化失败回调
wsOnReConnect	() => any	-	否	websocket 重连回调
wsOnError	() => any	-	否	websocket 错误回调
wsOnClose	() => any	-	否	websocket 关闭回调

requestWsKeyConfigType 属性

属性名	类型	默认值	必填	描述
eventKey	string	-	否	事件键名
dataKey	string	-	否	事件数据键名

requestErrorRuleConfigType 属性

属性名	类型	默认值	必填	描述
codeHandler	(code: number) => boolean	-	否	自定义状态码处理回调
rejectHandler	(res: any) => string	-	否	自定义内容处理回调