Type Alias ScratchOrgCreateOptions

ScratchOrgCreateOptions: {
    alias?: string;
    apiversion?: string;
    clientSecret?: string;
    connectedAppConsumerKey?: string;
    definitionfile?: string;
    definitionjson?: string;
    durationDays?: number;
    hubOrg: Org;
    noancestors?: boolean;
    nonamespace?: boolean;
    orgConfig?: Record<string, unknown>;
    retry?: number;
    setDefault?: boolean;
    tracksSource?: boolean;
    wait?: Duration;
}

Type declaration

  • Optionalalias?: string

    alias to set for the created org

  • Optionalapiversion?: string

    target server instance API version

  • OptionalclientSecret?: string

    OAuth client secret of personal connected app

  • OptionalconnectedAppConsumerKey?: string

    The connected app consumer key.

  • Optionaldefinitionfile?: string

    path to an org definition file

    Deprecated

    use orgConfig

  • Optionaldefinitionjson?: string

    org definition in JSON format, stringified

    Deprecated

    use orgConfig

  • OptionaldurationDays?: number

    duration of the scratch org (in days) (default:1, min:1, max:30)

  • hubOrg: Org

    the environment hub org

  • Optionalnoancestors?: boolean

    create the scratch org with no second-generation package ancestors

  • Optionalnonamespace?: boolean

    create the scratch org with no namespace

  • OptionalorgConfig?: Record<string, unknown>

    overrides definitionjson

  • Optionalretry?: number

    number of scratch org auth retries after scratch org is successfully signed up (default:0, min:0, max:10)

  • OptionalsetDefault?: boolean

    after complete, set the org as the default

  • OptionaltracksSource?: boolean

    if false, do not use source tracking for this scratch org

  • Optionalwait?: Duration

    the streaming client socket timeout (in minutes) must be an instance of the Duration utility class (default:6)

Settings

Member Visibility