isMinVersionSupported

현재 실행 중인 토스 앱의 버전이 파라미터로 전달된 플랫폼별 최소 버전 요구사항을 충족하는지 동기적으로 확인합니다. 특정 기능이 최신 버전에서만 동작할 때, 사용자에게 앱 업데이트를 안내하는 데 활용합니다.

시그니처

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

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

파라미터

이름	타입	필수	설명
minVersions	object	✓	플랫폼별 최소 버전 요구사항 객체입니다.
minVersions.android	`${number}.${number}.${number}` | 'always' | 'never'	✓	Android 최소 버전. 'always'는 모든 버전에서 지원, 'never'는 모든 버전에서 미지원.
minVersions.ios	`${number}.${number}.${number}` | 'always' | 'never'	✓	iOS 최소 버전. 'always'는 모든 버전에서 지원, 'never'는 모든 버전에서 미지원.

반환값

• boolean — 현재 앱 버전이 플랫폼별 최소 버전 이상이면 true, 그렇지 않으면 false.

권한

권한이 필요하지 않습니다 — isMinVersionSupported는 별도의 PermissionName에 바인딩되지 않습니다. 권한이 필요한 다른 네임스페이스의 일반적인 처리 흐름은 Guides — 권한 처리 패턴을 참고하세요.

예제

최소 예제

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

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

if (!isSupported) {
  console.log('앱을 최신 버전으로 업데이트해 주세요.');
}

실전 예제 — 버전 미지원 시 업데이트 안내

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

function FeaturePage() {
  const isSupported = isMinVersionSupported({
    android: '5.150.0',
    ios: '5.120.0',
  });

  if (!isSupported) {
    return (
      <div>
        <h2>앱 업데이트가 필요합니다</h2>
        <p>이 기능은 최신 버전의 토스 앱에서만 사용할 수 있습니다. 앱을 업데이트한 후 다시 시도해 주세요.</p>
      </div>
    );
  }

  return (
    <div>
      <h2>새로운 기능</h2>
      {/* 최신 버전에서만 사용 가능한 기능 */}
    </div>
  );
}

'always' / 'never' 특수값 활용

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

// iOS에서만 제공되는 기능: Android는 'never'로 항상 false
const isIosOnlySupported = isMinVersionSupported({
  android: 'never',
  ios: '5.100.0',
});

// 모든 버전에서 지원: 'always'는 버전 체크 없이 true
const isAlwaysSupported = isMinVersionSupported({
  android: 'always',
  ios: 'always',
});

직접 실행해 보기

sdk-example의 Environment 페이지에서 isMinVersionSupported 카드를 실행해 결과를 확인할 수 있습니다.

→sdk-example에서 실행해 보기

관련 API

• getTossAppVersion — 현재 앱 버전 문자열을 반환합니다.
• getPlatformOS — 현재 플랫폼 OS를 반환합니다.
• getServerTime — getServerTime.isSupported()로 기능 지원 여부를 확인하는 패턴도 참고하세요.

관련 가이드

• Guides — 권한 처리 패턴 — 다른 네임스페이스의 권한 흐름 (참고용; isMinVersionSupported는 권한이 필요하지 않습니다).
• Recipes — 앱 버전 분기 및 업데이트 안내 패턴

외부 참조

• @apps-in-toss/web-framework — 상위 SDK 패키지. 실제 export는 내부적으로 @apps-in-toss/web-bridge에서 가져옵니다.
• 표준 Web API 대응: 없음 — 호스트 앱 버전 확인은 표준 Web API로 수행할 수 없습니다.