Class Global

constructor

• new Global(): Global

• Returns Global

Static SFDX_INTEROPERABILITY

Static Readonly SFDX_STATE_FOLDER

Static Readonly SF_STATE_FOLDER

Static Readonly STATE_FOLDER

Static DIR

• get DIR(): string

• The full system path to the preferred global state folder

  Returns string

Static SFDX_DIR

• get SFDX_DIR(): string

• The full system path to the global sfdx state folder.

  See Global.SFDX_STATE_FOLDER

  Returns string

Static SF_DIR

• get SF_DIR(): string

• The full system path to the global sf state folder.

  See Global.SF_STATE_FOLDER

  Returns string

Static isWeb

• get isWeb(): boolean

• Whether the code is running in a web browser.

  Returns boolean

Static createDir

• createDir(dirPath?): Promise<void>

• Creates a directory within Global.SFDX_DIR, or Global.SFDX_DIR itself if the dirPath param is not provided. This is resolved or rejected when the directory creation operation has completed.

  Parameters

  • Optional dirPath: string

    The directory path to be created within Global.SFDX_DIR.

  Returns Promise<void>

Static getEnvironmentMode

• getEnvironmentMode(): Mode

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

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

  Returns Mode