@salesforce/core
Options
All
  • Public
  • Public/Protected
  • All
Menu

Global constants, methods, and configuration.

Hierarchy

  • Global

Index

Properties

Methods

Properties

Static DIR

DIR: string = path.join(os.homedir(),Global.STATE_FOLDER)

The full system path to the global state folder.

see

Global.STATE_FOLDER

Static LOG_FILE_PATH

LOG_FILE_PATH: string = path.join(Global.DIR,'sfdx.log')

The full system path to the global log file.

Static STATE_FOLDER

STATE_FOLDER: ".sfdx" = ".sfdx"

The global folder in which state is stored.

Methods

Static createDir

  • createDir(dirPath?: undefined | string): Promise<void>

  • Creates a directory within Global.DIR, or Global.DIR itself if the dirPath param is not provided.

    Parameters

    • Optional dirPath: undefined | string

    Returns Promise<void>

    Resolved or rejected when the directory creation operation has completed.

Static getEnvironmentMode

  • getEnvironmentMode(): Mode

  • Gets the current mode environment variable as a Mode instance.

    example

    console.log(Global.getEnvironmentMode() === Mode.PRODUCTION);

    Returns Mode