Skip to main content
Use this API to determine whether the Mini Program is running in a development or production environment.

​
Parameters

PropertyTypeRequiredDescription
successFunctionNoCallback on successful execution
failFunctionNoCallback on failure
completeFunctionNoCallback that always executes

​
Success Callback

PropertyTypeDescription
envVersionStringCurrent environment: develop or release

​
Fail Callback

PropertyTypeDescription
errorStringError code
errorMessageStringError description

​
Error Codes

CodeDescription
3An unknown error has occurred

​
Code Example

​
Basic Usage

my.getRunScene({
  success(result) {
    console.log('Environment:', result.envVersion);

    if (result.envVersion === 'develop') {
      console.log('Running in development mode');
    } else {
      console.log('Running in production mode');
    }
  },
  fail(error) {
    console.error('Failed to get run scene:', error.errorMessage);
  }
});

​
Using with async/await

async function checkEnvironment() {
  try {
    const result = await my.getRunScene();
    return result.envVersion;
  } catch (error) {
    console.error('Error:', error.errorMessage);
    return null;
  }
}

Page({
  async onLoad() {
    const env = await checkEnvironment();
    this.setData({ isDevelopment: env === 'develop' });
  }
});

​
Conditional Feature Loading

Page({
  onLoad() {
    my.getRunScene({
      success: (res) => {
        if (res.envVersion === 'develop') {
          // Enable debug features
          this.enableDebugMode();
        }

        // Set environment for analytics
        this.setData({
          environment: res.envVersion
        });
      }
    });
  },

  enableDebugMode() {
    console.log('Debug mode enabled');
    // Add debug-specific functionality
  }
});

​
Display Environment Badge

Page({
  data: {
    envBadge: ''
  },

  onLoad() {
    my.getRunScene({
      success: (res) => {
        this.setData({
          envBadge: res.envVersion === 'develop' ? 'DEV' : ''
        });
      }
    });
  }
});

​
Use Cases

Enable verbose logging only in development:
my.getRunScene({
  success({ envVersion }) {
    if (envVersion === 'develop') {
      console.log = (...args) => {
        // Enhanced logging for development
        console.info('[DEV]', ...args);
      };
    }
  }
});
Switch between development and production APIs:
let apiBaseUrl = '';

my.getRunScene({
  success({ envVersion }) {
    apiBaseUrl = envVersion === 'develop'
      ? 'https://dev-api.example.com'
      : 'https://api.example.com';
  }
});
Enable experimental features in development:
const features = {
  experimentalUI: false,
  debugPanel: false
};

my.getRunScene({
  success({ envVersion }) {
    if (envVersion === 'develop') {
      features.experimentalUI = true;
      features.debugPanel = true;
    }
  }
});

my.getAppIdSync

Get the App ID

my.canIUse

Check feature support