Skip to main content

getTossAppVersion

Synchronously returns the version of the currently running Toss app as a semver string (e.g. '5.206.0'). Useful for logging and for coarse version-based feature branching.

Signature​

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

declare function getTossAppVersion(): string;

Parameters​

None.

Returns​

  • string — the Toss app version string in major.minor.patch format. Example: '5.206.0'.
Use isMinVersionSupported for version comparisons

Direct string comparison (>, <) uses lexicographic ordering and can produce wrong results. Use isMinVersionSupported whenever you need to gate functionality on a minimum version.

Permission​

No permission required — getTossAppVersion is not bound to a PermissionName. For the typical permission flow used by other namespaces, see Guides — Permissions pattern.

Examples​

Minimal​

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

const version = getTossAppVersion();
console.log('Toss app version:', version); // e.g. '5.206.0'

Realistic — include version in error reports​

import { getTossAppVersion, getPlatformOS } from '@apps-in-toss/web-framework';
import { useEffect } from 'react';

function App() {
  useEffect(() => {
    const appVersion = getTossAppVersion();
    const platform = getPlatformOS();

    window.addEventListener('unhandledrejection', (event) => {
      console.error('[error]', {
        appVersion,
        platform,
        reason: event.reason,
      });
    });
  }, []);

  return <main>{/* app content */}</main>;
}

Try it live​

Open the Environment page in sdk-example and run the getTossAppVersion card to inspect the result.

Open in sdk-example

External references​