Skip to content

引入

ts
import {
  DEFAULT_ENV_STORAGE_KEY,
  GLOBAL_BUILD_ENV_KEY,
  DEFAULT_GLOBAL_SET_ENV,
  readWxEnvVersion,
  getGlobalBuildEnv,
  inferDefaultEnv,
  readEnv,
  createEnvSwitcher,
  setupEnvSwitchHotspot,
  Env
} from 't-comm';

// 不支持 tree-shaking 的项目
import {
  DEFAULT_ENV_STORAGE_KEY,
  GLOBAL_BUILD_ENV_KEY,
  DEFAULT_GLOBAL_SET_ENV,
  readWxEnvVersion,
  getGlobalBuildEnv,
  inferDefaultEnv,
  readEnv,
  createEnvSwitcher,
  setupEnvSwitchHotspot,
  Env
} from 't-comm/lib/cocos/env/index';

// 只支持 ESM 的项目
import {
  DEFAULT_ENV_STORAGE_KEY,
  GLOBAL_BUILD_ENV_KEY,
  DEFAULT_GLOBAL_SET_ENV,
  readWxEnvVersion,
  getGlobalBuildEnv,
  inferDefaultEnv,
  readEnv,
  createEnvSwitcher,
  setupEnvSwitchHotspot,
  Env
} from 't-comm/es/cocos/env/index';

DEFAULT_ENV_STORAGE_KEY

描述:默认存储 key

参数

GLOBAL_BUILD_ENV_KEY

描述:构建期注入的全局变量 key:项目通过 globalThis[COCOS_BUILD_NETWORK_ENV] 设置默认环境

参数

DEFAULT_GLOBAL_SET_ENV

描述:默认全局调试函数名

参数

readWxEnvVersion()

描述:读取微信小程序/小游戏当前的版本(develop / trial / release)。 非小程序环境或调用失败返回 ''。

参数

getGlobalBuildEnv()

描述:读取构建期通过 globalThis 注入的默认环境(如 CI --env prod)。 未注入或值非法时返回 undefined。

参数

inferDefaultEnv()

描述:推断"未手动设置过环境"时的默认 env:

    - globalThis.COCOS_BUILD_NETWORK_ENV(构建期注入) - 小程序正式版(release) → 'prod' - 其他情况 → 'test'

参数

readEnv()

描述:读取当前生效的环境:

  • 优先读取持久化存储中的手动切换值(与 createEnvSwitcher 内部 readEnv 保持一致)
  • 没有持久化值时回退到 inferDefaultEnv()(含 globalThis 构建注入)

参数

createEnvSwitcher()

描述:创建一个环境切换器。

参数

setupEnvSwitchHotspot()

描述:在屏幕右上角注册一个隐藏触摸热区,连点 5 次(3 秒内)弹出环境切换菜单。 触发区域:屏幕宽度 80%~100%、高度 0%~15% 的矩形区域。

参数

Env

描述:当前支持的环境枚举

参数