版本

1. 获取 Toss 应用版本 (getTossAppVersion)

getTossAppVersion 这个函数会获取 Toss 应用版本。例如， 5.206.0会以如下形式返回。可用于将 Toss 应用版本记录到日志，或者在某些功能仅在特定版本及以上运行时使用。

签名

function getTossAppVersion(): string;

返回值

• string

  Toss 应用版本

示例

js

import { getTossAppVersion } from '@apps-in-toss/web-framework';

const tossAppVersion = getTossAppVersion();

React

import { getTossAppVersion } from '@apps-in-toss/web-framework';
import { Text } from '@toss/tds-mobile';

function TossAppVersionPage() {
  const tossAppVersion = getTossAppVersion();

  return <Text>{tossAppVersion}</Text>;
}

React Native

import { getTossAppVersion } from '@apps-in-toss/framework';
import { Text } from '@toss/tds-react-native';

function TossAppVersionPage() {
  const tossAppVersion = getTossAppVersion();

  return <Text>{tossAppVersion}</Text>;
}

---

2. 检查应用最低版本 (isMinVersionSupported)

这个函数会检查当前运行中的 Toss 应用版本是否满足通过参数传入的最低版本要求。当某个功能仅在最新版本中可用时，可以提示用户更新应用。

签名

function isMinVersionSupported(minVersions: {
  android: `${number}.${number}.${number}` | 'always' | 'never';
  ios: `${number}.${number}.${number}` | 'always' | 'never';
}): boolean;

参数

• minVersions · 必填 · 对象

  用于指定各平台最低版本要求的对象。

  • minVersions.android · 必填 · (${number}.${number}.${number} | 'always' | 'never')

    这是 Android 平台的最低版本要求。
  • minVersions.ios · 必填 · (${number}.${number}.${number} | 'always' | 'never')

    这是 iOS 平台的最低版本要求。

返回值

• boolean

  如果当前应用版本高于或等于最低版本，则返回 true；否则返回 false。

示例

js

import { isMinVersionSupported } from '@apps-in-toss/web-framework';

const isSupported = isMinVersionSupported({
  android: '1.2.0',
  ios: '1.3.0',
});

React

import { isMinVersionSupported } from '@apps-in-toss/web-framework';
import { Text } from '@toss/tds-mobile';

function VersionCheck() {
  const isSupported = isMinVersionSupported({
    android: '1.2.0',
    ios: '1.3.0',
  });

  return <div>{!isSupported && <Text>需要更新到最新版本。</Text>};
}

React Native

import { isMinVersionSupported } from '@apps-in-toss/framework';
import { Text } from '@toss/tds-react-native';
import { View } from 'react-native';

function VersionCheck() {
  const isSupported = isMinVersionSupported({
    android: '1.2.0',
    ios: '1.3.0',
  });

  return <View>{!isSupported && <Text>需要更新到最新版本。</Text>}</View>;
}