본문으로 건너뛰기

환경 (env)

🔔 최신화 일자: 2025-02-20

개요​

env 네임스페이스는 nachocode SDK의 현재 실행 환경을 관리하는 기능을 제공합니다.

현재 SDK 버전, 애플리케이션 실행 환경(Web/App), 샌드박스 모드 여부 등을 확인할 수 있으며, SDK 초기화 여부도 확인할 수 있습니다.

타입 정의​

RunningEnvironment​

애플리케이션 실행 환경을 나타내는 열거형(enum)입니다.

값설명
web웹 애플리케이션에서 실행됨 (browser)
app네이티브 애플리케이션에서 실행됨 (Android 또는 iOS)

CurrentEnvironment​

현재 애플리케이션 환경을 나타내는 타입입니다.

필드타입설명
deviceTypeNachocode.device.DeviceType현재 디바이스 유형
loggerboolean로거 사용 여부 (true / false)
runningEnvRunningEnvironment현재 실행 환경 (web / app)
sandboxboolean샌드박스 서버 사용 여부 (true / false)
sdkVersionstring현재 SDK 버전
srcVersionstring현재 앱 소스 버전

EnvironmentOptions​

애플리케이션 환경 옵션을 나타내는 타입입니다.

필드타입설명
sandboxboolean샌드박스 서버 사용 여부
loggerboolean로거 사용 여부

메서드 목록​

메서드설명추가된 버전
getAppSourceVersion()현재 애플리케이션 소스 버전을 반환합니다.ver.1.2.0
getCurrentEnv()현재 애플리케이션 환경을 반환합니다.ver.1.0.0
getRunningEnv()현재 실행 환경을 반환합니다.ver.1.0.0
getSDKVersion()현재 SDK 버전을 반환합니다.ver.1.0.0
isApp()애플리케이션이 네이티브 앱에서 실행 중인지 확인합니다.ver.1.0.0
isInitialized()SDK가 초기화되었는지 여부를 확인합니다.ver.1.0.0
isUsingSandbox()현재 샌드박스 서버를 사용 중인지 확인합니다.ver.1.0.0
isWeb()애플리케이션이 웹 환경에서 실행 중인지 확인합니다.ver.1.0.0

메서드 상세​

getAppSourceVersion(): string​

  • since ver.1.2.0

설명 (getAppSourceVersion)​

현재 실행 중인 앱의 소스 코드 버전을 반환합니다.
nachocode에서 제공하는 앱 소스 코드의 버전을 의미하며, SDK 버전과 다를 수 있습니다.

⚠️ 참고: SDK 버젼보다 앱 소스 버젼이 낮을 경우 SDK 일부 기능 사용이 제한됩니다.

반환 값 (getAppSourceVersion)​

타입설명
stringnachocode 앱 소스 버전

사용 예제 (getAppSourceVersion)​

const currentVersion = Nachocode.env.getAppSourceVersion();

console.log(`앱 소스 버전: ${appSourceVersion}`); // ex. "1.5.0"

getCurrentEnv(): CurrentEnvironment​

  • since ver.1.0.0

설명 (getCurrentEnv)​

현재 애플리케이션의 환경 정보(디바이스 타입, 실행 환경, SDK 버전 등)를 반환합니다.

반환 값 (getCurrentEnv)​

타입설명
CurrentEnvironment현재 애플리케이션 환경 객체

사용 예제 (getCurrentEnv)​

const currentEnv = Nachocode.env.getCurrentEnv();

console.log(currentEnv); // ex. { deviceType: 'iOS', logger: false, runningEnv: 'app', sandbox: false, sdkVersion: "1.5.0", srcVersion: "1.5.0" }

getRunningEnv(): RunningEnvironment​

  • since ver.1.0.0

설명 (getRunningEnv)​

현재 앱이 실행 중인 환경이 웹(web) 환경인지, 네이티브 앱(app) 환경인지 확인할 수 있습니다.

반환 값 (getRunningEnv)​

타입설명
RunningEnvironment현재 실행 환경 (web / app)

사용 예제 (getRunningEnv)​

const runningEnv = Nachocode.env.getRunningEnv(); // 'web' | 'app'
console.log(`현재 실행 환경: ${runningEnv}`); // "app" 또는 "web"

getSDKVersion(): string​

  • since ver.1.0.0

설명 (getSDKVersion)​

현재 nachocode SDK의 버전 정보를 반환합니다.

반환 값 (getSDKVersion)​

타입설명
stringSDK 버전 정보

사용 예제 (getSDKVersion)​

const sdkVersion = Nachocode.env.getSDKVersion();
console.log(`nachocode SDK 버전: ${sdkVersion}`); // ex. "1.5.0"

isApp(): boolean​

  • since ver.1.0.0

설명 (isApp)​

애플리케이션이 네이티브 앱 환경(Android/iOS)에서 실행 중인지 확인하여 여부를 반환합니다.

반환 값 (isApp)​

타입설명
boolean네이티브 앱 실행 여부 반환 (true / false)

사용 예제 (isApp)​

if (Nachocode.env.isApp()) {
  console.log('현재 네이티브 앱에서 실행 중입니다.');
  // 앱 환경에서만 동작할 로직을 작성합니다.
}

isInitialized(): boolean​

  • since ver.1.0.0

설명 (isInitialized)​

nachocode SDK가 정상적으로 초기화되었는지 여부를 반환합니다.

반환 값 (isInitialized)​

타입설명
booleanSDK 초기화 여부 (true / false)

사용 예제 (isInitialized)​

if (Nachocode.env.isInitialized()) {
  // nachocode SDK가 초기화 되었을 때만 실행 할 로직을 작성합니다.
} else {
  // SDK가 초기화 되지 않았다면 초기화를 시도합니다.
  Nachocode.init('your_api_key_here');
}

isUsingSandbox(): boolean​

  • since ver.1.0.0

설명 (isUsingSandbox)​

현재 애플리케이션이 샌드박스 환경에서 실행 중인지 여부를 반환합니다.

반환 값 (isUsingSandbox)​

타입설명
boolean샌드박스 여부 (true / false)

사용 예제 (isUsingSandbox)​

console.log(Nachocode.env.isUsingSandbox()); // true | false
if (Nachocode.env.isUsingSandbox()) {
  // Sandbox 서버를 사용 중일 때만 실행할 로직을 작성합니다.
  console.log('현재 샌드박스 환경에서 실행 중입니다.');
}

isWeb(): boolean​

  • since ver.1.0.0

설명 (isWeb)​

현재 애플리케이션 실행 환경이 웹 환경인지 여부를 반환합니다.

반환 값 (isWeb)​

타입설명
boolean웹 실행 여부 (true / false)

사용 예제 (isWeb)​

if (Nachocode.env.isWeb()) {
  console.log('현재 웹 애플리케이션에서 실행 중입니다.');
  // 웹 환경에서만 동작할 로직을 작성합니다.
}