Class Global

constructor

• new Global(): Global

• Returns Global

Static ReadonlySF_STATE_FOLDER

StaticSFDX_INTEROPERABILITY

Static ReadonlySFDX_STATE_FOLDER

Static ReadonlySTATE_FOLDER

StaticDIR

• get DIR(): string

• The full system path to the preferred global state folder

  Returns string

StaticisWeb

• get isWeb(): boolean

• Whether the code is running in a web browser.

  Returns boolean

StaticSF_DIR

• get SF_DIR(): string

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

  See Global.SF_STATE_FOLDER

  Returns string

StaticSFDX_DIR

• get SFDX_DIR(): string

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

  See Global.SFDX_STATE_FOLDER

  Returns string

StaticcreateDir

• 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

  • OptionaldirPath: string

    The directory path to be created within Global.SFDX_DIR.

  Returns Promise<void>

StaticgetEnvironmentMode

• getEnvironmentMode(): Mode

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

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

  Returns Mode