Type alias Options

Options: {
    filePath?: string;
    filename?: string;
    isGlobal?: boolean;
    isState?: boolean;
    rootFolder?: string;
    stateFolder?: string;
    throwOnNotFound?: boolean;
} & BaseConfigStore.Options

The interface for Config options.

Type declaration

  • Optional filePath?: string

    The full file path where the config file is stored.

  • Optional filename?: string

    The file name.

  • Optional isGlobal?: boolean

    If the file is in the global or project directory.

  • Optional isState?: boolean

    If the file is in the state folder or no (.sfdx).

  • Optional rootFolder?: string

    The root folder where the config file is stored.

  • Optional stateFolder?: string

    The state folder where the config file is stored.

  • Optional throwOnNotFound?: boolean

    Indicates if init should throw if the corresponding config file is not found.

Settings

Member Visibility

Theme