getOperationalEnvironment

현재 미니앱이 실행되는 운영 환경을 동기적으로 반환합니다. 토스 앱에서 실행 중이라면 'toss', 샌드박스 환경이라면 'sandbox'를 반환합니다. 환경에 따라 기능 가용성을 분기하거나 디버깅 도구를 활성화할 때 유용합니다.

시그니처

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

declare function getOperationalEnvironment(): 'toss' | 'sandbox';

파라미터

없음.

반환값

• 'toss' — 토스 앱(프로덕션 또는 QA 빌드) 내에서 실행 중입니다.
• 'sandbox' — 샌드박스 환경에서 실행 중입니다.

권한

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

예제

최소 예제

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

const env = getOperationalEnvironment();
console.log('운영 환경:', env); // 'toss' 또는 'sandbox'

실전 예제 — 환경별 디버그 배너 표시

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

function DebugBanner() {
  const env = getOperationalEnvironment();

  if (env !== 'sandbox') return null;

  return (
    <div style={{ background: '#ff6b6b', color: '#fff', padding: '4px 12px', fontSize: 12 }}>
      샌드박스 환경 — 실제 데이터에 영향을 주지 않습니다
    </div>
  );
}

직접 실행해 보기

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

→sdk-example에서 실행해 보기

관련 API

• getPlatformOS — 현재 플랫폼 OS를 반환합니다.
• getTossAppVersion — 토스 앱 버전을 반환합니다.
• isMinVersionSupported — 현재 앱 버전이 최소 버전 이상인지 확인합니다.

관련 가이드

• Guides — 권한 처리 패턴 — 다른 네임스페이스의 권한 흐름 (참고용; getOperationalEnvironment는 권한이 필요하지 않습니다).
• Recipes — 샌드박스/프로덕션 환경 분기 패턴

외부 참조

• @apps-in-toss/web-framework — 상위 SDK 패키지. 실제 export는 내부적으로 @apps-in-toss/web-bridge에서 가져옵니다.
• 표준 Web API 대응: 없음 — 운영 환경 구분은 미니앱 플랫폼 고유 개념입니다.