Class default

Helper class for dealing with the settings that are defined in a scratch definition file. This class knows how to extract the settings from the definition, how to expand them into a MD directory and how to generate a package.xml.

Index

Constructors

constructor

Methods

createDeploy createDeployPackageContents deploySettingsViaFolder extract getDestinationPath getShapeDirName hasSettings

Constructors

constructor

new default(
    options?: {
        asDirectory?: boolean;
        capitalizeRecordTypes?: boolean;
        mdApiTmpDir?: string;
        shapeDirName?: string;
    },
): default
Parameters
- Optionaloptions: {
      asDirectory?: boolean;
      capitalizeRecordTypes?: boolean;
      mdApiTmpDir?: string;
      shapeDirName?: string;
  }
Returns default
- Defined in src/org/scratchOrgSettingsGenerator.ts:219

Methods

createDeploy

createDeploy(): Promise<void>
Create temporary deploy directory used to upload the scratch org shape. This will create the dir, all of the .setting files and minimal object files needed for objectSettings

Returns Promise<void>
- Defined in src/org/scratchOrgSettingsGenerator.ts:268

createDeployPackageContents

createDeployPackageContents(apiVersion: string): Promise<void>
Parameters
- apiVersion: string
Returns Promise<void>
- Defined in src/org/scratchOrgSettingsGenerator.ts:357

deploySettingsViaFolder

deploySettingsViaFolder(
    scratchOrg: Org,
    apiVersion: string,
    timeout?: Duration,
): Promise<void>
Deploys the settings to the org.
Parameters
- scratchOrg: Org
- apiVersion: string
- timeout: Duration = ...
Returns Promise<void>
- Defined in src/org/scratchOrgSettingsGenerator.ts:280

extract

extract(
    scratchDef: ScratchOrgInfo,
): Promise<
    {
        objectSettings: { [objectName: string]: ObjectSetting }
        | undefined;
        settings: Record<string, unknown> | undefined;
    },
>
extract the settings from the scratch def file, if they are present.
Parameters
- scratchDef: ScratchOrgInfo
Returns Promise<
    {
        objectSettings: { [objectName: string]: ObjectSetting }
        | undefined;
        settings: Record<string, unknown> | undefined;
    },
>
- Defined in src/org/scratchOrgSettingsGenerator.ts:249

getDestinationPath

getDestinationPath(): string | undefined
Returns the destination where the writer placed the settings content.

Returns string | undefined
- Defined in src/org/scratchOrgSettingsGenerator.ts:378

getShapeDirName

getShapeDirName(): string
Returns string
- Defined in src/org/scratchOrgSettingsGenerator.ts:370

hasSettings

hasSettings(): boolean
True if we are currently tracking setting or object setting data.

Returns boolean
- Defined in src/org/scratchOrgSettingsGenerator.ts:261

Class default

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns default

Methods

createDeploy

Returns Promise<void>

createDeployPackageContents

Parameters

Returns Promise<void>

deploySettingsViaFolder

Parameters

Returns Promise<void>

extract

Parameters

Returns Promise< { objectSettings: { [objectName: string]: ObjectSetting } | undefined; settings: Record<string, unknown> | undefined; },>

getDestinationPath

Returns string | undefined

getShapeDirName

Returns string

hasSettings

Returns boolean

Settings

On This Page

Returns Promise<
{
objectSettings: { [objectName: string]: ObjectSetting }
| undefined;
settings: Record<string, unknown> | undefined;
},
>