Matrix

Appearance

isThsPcTyClient ​

描述 ​

判断当前环境是否为同花顺PC统一客户端。通过检测 window.external.createObject 方法来判断是否为同花顺PC统一客户端。

语法 ​

ts
isThsPcTyClient(): boolean

返回值 ​

  • boolean: 如果是同花顺PC统一客户端返回 true，否则返回 false

异常 ​

  • 无异常抛出，在检测失败时会返回 false 并输出警告信息

示例 ​

基本用法 ​

ts
import { isThsPcTyClient } from '@fu/matrix';

if (isThsPcTyClient()) {
  // 在同花顺PC统一客户端中的处理逻辑
  console.log('当前在同花顺PC统一客户端中');
  // 可以使用客户端特有的功能
} else {
  // 在其他环境中的处理逻辑
  console.log('当前不在同花顺PC统一客户端中');
}

条件渲染 ​

ts
import { isThsPcTyClient } from '@fu/matrix';

// 根据客户端类型显示不同的内容
const renderContent = () => {
  if (isThsPcTyClient()) {
    return <div>同花顺PC统一客户端专用功能</div>;
  }
  return <div>通用功能</div>;
};

功能检测 ​

ts
import { isThsPcTyClient } from '@fu/matrix';

// 检测是否支持客户端特有功能
const checkClientFeatures = () => {
  if (isThsPcTyClient()) {
    // 同花顺PC统一客户端支持的功能
    return {
      canUseExternalAPI: true,
      canAccessFileSystem: true,
      canUseNativeFeatures: true
    };
  }
  
  return {
    canUseExternalAPI: false,
    canAccessFileSystem: false,
    canUseNativeFeatures: false
  };
};

实现原理 ​

该函数通过检测 window.external 对象及其 createObject 方法来判断当前环境。同花顺PC统一客户端会在全局 window 对象上提供 external 接口，其中包含 createObject 方法用于创建客户端对象。

兼容性 ​

  • 浏览器支持: 所有现代浏览器
  • Node.js 支持: 在服务端环境中返回 false
  • 移动端: 移动端环境返回 false

注意事项 ​

  1. 该函数依赖于浏览器环境，在服务端渲染时会返回 false
  2. 如果 window.external 对象不存在或 createObject 方法不可用，函数会返回 false
  3. 该检测方法仅适用于同花顺PC统一客户端，其他客户端（如远航版、期货通等）会返回 false

相关方法 ​

版本历史 ​

  • v1.0.0: 初始版本