@salesforce/core
    Preparing search index...

    Class Global

    Global constants, methods, and configuration.

    Index
    constructor
    SF_STATE_FOLDER SFDX_INTEROPERABILITY SFDX_STATE_FOLDER STATE_FOLDER
    DIR isWeb SF_DIR SFDX_DIR
    createDir getEnvironmentMode
    SF_STATE_FOLDER: ".sf" = '.sf'

    The global folder in which sf state is stored.

    SFDX_INTEROPERABILITY: boolean = ...

    Enable interoperability between .sfdx and .sf.

    When @salesforce/core@v2 is deprecated and no longer used, this can be removed.

    SFDX_STATE_FOLDER: ".sfdx" = '.sfdx'

    The global folder in which sfdx state is stored.

    STATE_FOLDER: ".sfdx" = Global.SFDX_STATE_FOLDER

    The preferred global folder in which state is stored.

    • get DIR(): string

      The full system path to the preferred global state folder

      Returns string

    • get isWeb(): boolean

      Whether the code is running in a web browser.

      Returns boolean

    • 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>

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

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

      Returns Mode

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods