# Environment

# env

interface BalmEnvObject {
  isProd: boolean;
  isTest: boolean;
  isDev: boolean;
  inSSR: boolean;
  isMP: boolean; // New in 2.9.0
}

env: BalmEnvObject

Balm workflow environment variable in Node.js.

  • env.isDev is true when running balm
  • env.isProd is true when running balm -p or balm --production
  • env.isTest is true when running balm -t or balm --test
  • env.inSSR is true when running balm -ssr or balm --server
  • env.isMP is true when running balm -mp or balm --miniprogram

# workspace

workspace: string = process.cwd()

(Absolute path) Make sure any symlinks in the project folder are resolved.

🌰 For example:

// File: /path/to/workspace/balm.config.js
const path = require('path');
const workspace = path.resolve(__dirname);

module.exports = {
  workspace
  // Other Options...
};

Tips: Usually no need to set.

# inFrontend

inFrontend: boolean = true

Set project type.

  • true for a static HTML project
  • false for a dynamic language project (e.g. PHP framework)

🌰 For example:

module.exports = {
  inFrontend: true
  // Other Options...
};

# useDefaults

useDefaults: boolean = true

Enable balm default tasks.

🌰 For example:

const config = {
  useDefaults: false // Don't start balm default tasks
  // Other Options...
};

const api = (mix) => {
  // Custom tasks by API
};

module.exports = (balm) => {
  return {
    config,
    api
  };
};

πŸ“ƒ Refer to Custom Task API

Last Updated: 3 hours ago