From 7d87119e6c03a4bdafd2c28e51b00dde60ebe2eb Mon Sep 17 00:00:00 2001 From: svc-cli-bot Date: Tue, 8 Oct 2024 20:12:33 +0000 Subject: [PATCH] docs: publishing gh-pages [skip ci] --- .../config_authInfoConfig.AuthInfoConfig.html | 70 +++++++------- classes/config_config.Config.html | 80 ++++++++-------- ...g_configAggregator.ConfigAggregator-1.html | 30 +++--- classes/config_configFile.ConfigFile-1.html | 68 ++++++------- .../config_configStore.BaseConfigStore.html | 32 +++---- classes/config_envVars.EnvVars.html | 4 +- classes/config_lwwMap.LWWMap.html | 4 +- classes/config_lwwRegister.LWWRegister.html | 4 +- ...onfig_orgUsersConfig.OrgUsersConfig-1.html | 70 +++++++------- ...g_sandboxOrgConfig.SandboxOrgConfig-1.html | 70 +++++++------- ...ndboxProcessCache.SandboxRequestCache.html | 68 ++++++------- classes/config_ttlConfig.TTLConfig-1.html | 68 ++++++------- classes/crypto_crypto.Crypto.html | 10 +- ...to_keyChainImpl.GenericKeychainAccess.html | 4 +- classes/crypto_secureBuffer.SecureBuffer.html | 8 +- ...deviceOauthService.DeviceOauthService.html | 10 +- classes/global.Global.html | 20 ++-- classes/lifecycleEvents.Lifecycle.html | 26 ++--- classes/logger_logger.Logger.html | 54 +++++------ classes/logger_memoryLogger.MemoryLogger.html | 4 +- classes/messages.Messages.html | 36 +++---- classes/org_authInfo.AuthInfo-1.html | 50 +++++----- classes/org_authRemover.AuthRemover.html | 10 +- classes/org_connection.Connection-1.html | 42 ++++---- classes/org_org.Org-1.html | 80 ++++++++-------- ...SetAssignment.PermissionSetAssignment.html | 6 +- .../org_scratchOrgCache.ScratchOrgCache.html | 68 ++++++------- ...recation.ScratchOrgFeatureDeprecation.html | 8 +- ...g_scratchOrgSettingsGenerator.default.html | 14 +-- classes/org_user.DefaultUserFields-1.html | 4 +- classes/org_user.User-1.html | 14 +-- classes/schema_validator.SchemaValidator.html | 12 +-- classes/sfError.SfError.html | 20 ++-- classes/sfProject.SfProject.html | 52 +++++----- classes/sfProject.SfProjectJson.html | 96 +++++++++---------- ...accessors_aliasAccessor.AliasAccessor.html | 24 ++--- ...accessors_orgAccessor.BaseOrgAccessor.html | 28 +++--- ...tor_accessors_orgAccessor.OrgAccessor.html | 28 +++--- ...ssors_sandboxAccessor.SandboxAccessor.html | 28 +++--- ...gator_stateAggregator.StateAggregator.html | 8 +- ...s_myDomainResolver.MyDomainResolver-1.html | 6 +- .../status_pollingClient.PollingClient-1.html | 6 +- ...t.PollingClient.DefaultPollingOptions.html | 4 +- ...tus_streamingClient.StreamingClient-1.html | 12 +-- ...Client.StreamingClient.DefaultOptions.html | 22 ++--- classes/status_types.CometClient.html | 14 +-- classes/testSetup.MockTestOrgData.html | 16 ++-- classes/testSetup.MockTestSandboxData.html | 6 +- .../testSetup.StreamingMockCometClient.html | 16 ++-- ...tSetup.StreamingMockCometSubscription.html | 8 +- classes/testSetup.TestContext.html | 50 +++++----- classes/util_cache.Cache.html | 4 +- .../util_directoryWriter.DirectoryWriter.html | 4 +- classes/util_sfdcUrl.SfdcUrl.html | 20 ++-- classes/util_zipWriter.ZipWriter.html | 4 +- classes/webOAuthServer.WebOAuthServer-1.html | 12 +-- classes/webOAuthServer.WebServer.html | 18 ++-- enums/config_config.SfConfigProperties.html | 4 +- enums/config_config.SfdxPropertyKeys.html | 20 ++-- ...gAggregator.ConfigAggregator.Location.html | 8 +- enums/config_envVars.EnvironmentVariable.html | 4 +- ...dboxOrgConfig.SandboxOrgConfig.Fields.html | 4 +- enums/global.Mode.html | 4 +- enums/logger_logger.LoggerLevel.html | 4 +- enums/org_org.Org.Fields.html | 26 ++--- enums/org_org.Org.Status.html | 10 +- enums/org_org.OrgTypes.html | 4 +- enums/org_org.SandboxEvents.html | 4 +- ...gConfigProperties.OrgConfigProperties.html | 20 ++-- ...tchOrgSettingsGenerator.RequestStatus.html | 4 +- ...lient.StreamingClient.ConnectionState.html | 4 +- ...ient.StreamingClient.TimeoutErrorType.html | 6 +- ...stSetup.StreamingMockSubscriptionCall.html | 4 +- .../config_lwwMap.stateFromContents.html | 2 +- .../lifecycleEvents.cloneUniqueListeners.html | 2 +- functions/logger_cleanup.cleanup.html | 2 +- functions/logger_cleanup.getOldLogFiles.html | 2 +- functions/logger_filters.filterSecrets.html | 2 +- functions/logger_logger.computeLevel.html | 2 +- functions/logger_transformStream.default.html | 2 +- ...messageTransformer.messageTransformer.html | 2 +- functions/org_org.sandboxIsResumable.html | 2 +- ...org_scratchOrgCreate.scratchOrgCreate.html | 2 +- ...org_scratchOrgCreate.scratchOrgResume.html | 2 +- ...rorCodes.checkScratchOrgInfoForErrors.html | 2 +- ...Codes.validateScratchOrgInfoForResume.html | 2 +- ...scratchOrgInfoApi.authorizeScratchOrg.html | 4 +- .../org_scratchOrgInfoApi.deploySettings.html | 2 +- ...ratchOrgInfoApi.pollForScratchOrgInfo.html | 2 +- ...scratchOrgInfoApi.queryScratchOrgInfo.html | 2 +- ...hOrgInfoApi.requestScratchOrgCreation.html | 2 +- .../org_scratchOrgInfoApi.resolveUrl.html | 2 +- ...rgInfoApi.updateRevisionCounterToZero.html | 2 +- ...gInfoGenerator.generateScratchOrgInfo.html | 2 +- ...cratchOrgInfoGenerator.getAncestorIds.html | 2 +- ...nfoGenerator.getScratchOrgInfoPayload.html | 2 +- .../org_scratchOrgLifecycleEvents.emit.html | 2 +- ...hOrgLifecycleEvents.emitPostOrgCreate.html | 2 +- ...ingsGenerator.createObjectFileContent.html | 2 +- ...cordTypeAndBusinessProcessFileContent.html | 2 +- .../sfProject.isNamedPackagingDirectory.html | 2 +- functions/sfProject.isPackagingDirectory.html | 2 +- ...cessors_aliasAccessor.getFileLocation.html | 2 +- functions/testSetup.instantiateContext.html | 2 +- functions/testSetup.restoreContext.html | 2 +- functions/testSetup.shouldThrow.html | 2 +- functions/testSetup.shouldThrowSync.html | 2 +- functions/testSetup.stubContext.html | 2 +- functions/util_fileLocking.lockInit.html | 2 +- functions/util_fileLocking.lockInitSync.html | 2 +- .../util_fileLocking.pollUntilUnlock.html | 2 +- .../util_fileLocking.pollUntilUnlockSync.html | 2 +- .../util_findSuggestion.findSuggestion.html | 2 +- ...ndUppercaseKeys.ensureNoUppercaseKeys.html | 2 +- ...l_getJwtAudienceUrl.getJwtAudienceUrl.html | 2 +- functions/util_mapKeys.default.html | 2 +- functions/util_sfdc.matchesAccessToken.html | 2 +- functions/util_sfdc.trimTo15.html | 2 +- functions/util_sfdc.validateApiVersion.html | 2 +- functions/util_sfdc.validateEmail.html | 2 +- ...alidatePathDoesNotContainInvalidChars.html | 2 +- functions/util_sfdc.validateSalesforceId.html | 2 +- .../util_sfdcUrl.getLoginAudienceCombos.html | 2 +- functions/util_time.nowBigInt.html | 2 +- functions/util_uniqid.uniqid.html | 2 +- functions/util_unwrapArray.unwrapArray.html | 2 +- interfaces/org_connection.Tooling.html | 4 +- .../org_scratchOrgInfoApi.JsForceError.html | 4 +- ...reamingClient.StreamingClient.Options.html | 16 ++-- modules/config_authInfoConfig.html | 2 +- modules/config_config.html | 2 +- ...fig_configAggregator.ConfigAggregator.html | 2 +- modules/config_configAggregator.html | 2 +- modules/config_configFile.ConfigFile.html | 2 +- modules/config_configFile.html | 2 +- modules/config_configStackTypes.html | 2 +- modules/config_configStore.html | 2 +- modules/config_envVars.html | 2 +- modules/config_lwwMap.html | 2 +- modules/config_lwwRegister.html | 2 +- .../config_orgUsersConfig.OrgUsersConfig.html | 2 +- modules/config_orgUsersConfig.html | 2 +- ...fig_sandboxOrgConfig.SandboxOrgConfig.html | 2 +- modules/config_sandboxOrgConfig.html | 2 +- modules/config_sandboxProcessCache.html | 2 +- modules/config_ttlConfig.TTLConfig.html | 2 +- modules/config_ttlConfig.html | 2 +- modules/crypto_crypto.html | 2 +- modules/crypto_keyChain.html | 2 +- modules/crypto_keyChainImpl.html | 2 +- modules/crypto_secureBuffer.html | 2 +- modules/deviceOauthService.html | 2 +- modules/global.html | 2 +- modules/index.html | 2 +- modules/lifecycleEvents.html | 2 +- modules/logger_cleanup.html | 2 +- modules/logger_filters.html | 2 +- modules/logger_logger.html | 2 +- modules/logger_memoryLogger.html | 2 +- modules/logger_transformStream.html | 2 +- modules/messageTransformer.html | 2 +- modules/messages.html | 2 +- modules/org_authInfo.AuthInfo.html | 2 +- modules/org_authInfo.html | 2 +- modules/org_authRemover.html | 2 +- modules/org_connection.Connection.html | 2 +- modules/org_connection.html | 2 +- modules/org_org.Org.html | 2 +- modules/org_org.html | 2 +- modules/org_orgConfigProperties.html | 2 +- modules/org_permissionSetAssignment.html | 2 +- modules/org_scratchOrgCache.html | 2 +- modules/org_scratchOrgCreate.html | 2 +- modules/org_scratchOrgErrorCodes.html | 2 +- modules/org_scratchOrgFeatureDeprecation.html | 2 +- modules/org_scratchOrgInfoApi.html | 2 +- modules/org_scratchOrgInfoGenerator.html | 2 +- modules/org_scratchOrgLifecycleEvents.html | 2 +- modules/org_scratchOrgSettingsGenerator.html | 2 +- modules/org_scratchOrgTypes.html | 2 +- modules/org_user.DefaultUserFields.html | 2 +- modules/org_user.User.html | 2 +- modules/org_user.html | 2 +- modules/schema_validator.html | 2 +- modules/sfError.html | 2 +- modules/sfProject.html | 2 +- ...ateAggregator_accessors_aliasAccessor.html | 2 +- ...stateAggregator_accessors_orgAccessor.html | 2 +- ...eAggregator_accessors_sandboxAccessor.html | 2 +- modules/stateAggregator_stateAggregator.html | 2 +- ...tus_myDomainResolver.MyDomainResolver.html | 2 +- modules/status_myDomainResolver.html | 2 +- .../status_pollingClient.PollingClient.html | 2 +- modules/status_pollingClient.html | 2 +- ...tatus_streamingClient.StreamingClient.html | 2 +- modules/status_streamingClient.html | 2 +- modules/status_types.html | 2 +- modules/testSetup.html | 2 +- modules/util_cache.html | 2 +- modules/util_directoryWriter.html | 2 +- modules/util_fileLocking.html | 2 +- modules/util_findSuggestion.html | 2 +- modules/util_findUppercaseKeys.html | 2 +- modules/util_getJwtAudienceUrl.html | 2 +- modules/util_internal.html | 2 +- modules/util_lockRetryOptions.html | 2 +- modules/util_mapKeys.html | 2 +- modules/util_sfdc.html | 2 +- modules/util_sfdcUrl.html | 2 +- modules/util_structuredWriter.html | 2 +- modules/util_time.html | 2 +- modules/util_uniqid.html | 2 +- modules/util_unwrapArray.html | 2 +- modules/util_zipWriter.html | 2 +- modules/webOAuthServer.WebOAuthServer.html | 2 +- modules/webOAuthServer.html | 2 +- types/config_config.ConfigProperties.html | 2 +- types/config_config.ConfigPropertyMeta.html | 2 +- ...config_config.ConfigPropertyMetaInput.html | 2 +- ...igAggregator.ConfigAggregator.Options.html | 2 +- types/config_configAggregator.ConfigInfo.html | 2 +- .../config_configFile.ConfigFile.Options.html | 2 +- ...onfig_configStackTypes.ConfigContents.html | 2 +- .../config_configStackTypes.ConfigEntry.html | 2 +- .../config_configStackTypes.ConfigValue.html | 2 +- types/config_configStackTypes.Key.html | 2 +- types/config_configStore.ConfigStore.html | 2 +- types/config_lwwMap.LWWState.html | 2 +- ...orgUsersConfig.OrgUsersConfig.Options.html | 2 +- ...boxOrgConfig.SandboxOrgConfig.Options.html | 2 +- ...ProcessCache.SandboxRequestCacheEntry.html | 2 +- .../config_ttlConfig.TTLConfig.Contents.html | 2 +- types/config_ttlConfig.TTLConfig.Entry.html | 2 +- types/config_ttlConfig.TTLConfig.Options.html | 2 +- types/crypto_keyChainImpl.FsIfc.html | 2 +- types/crypto_keyChainImpl.KeyChain.html | 2 +- types/crypto_keyChainImpl.PasswordStore.html | 4 +- .../crypto_secureBuffer.DecipherCallback.html | 2 +- ...authService.DeviceCodePollingResponse.html | 2 +- ...deviceOauthService.DeviceCodeResponse.html | 2 +- types/lifecycleEvents.UniqueListenerMap.html | 2 +- types/lifecycleEvents.callback.html | 2 +- types/logger_logger.FieldValue.html | 2 +- types/logger_logger.Fields.html | 2 +- types/logger_logger.LogLine.html | 2 +- types/logger_logger.LoggerLevelValue.html | 2 +- types/logger_logger.LoggerOptions.html | 2 +- types/messages.LoaderFunction.html | 2 +- types/messages.StoredMessage.html | 2 +- types/messages.StoredMessageMap.html | 2 +- types/messages.StructuredMessage.html | 2 +- types/messages.Tokens.html | 2 +- types/org_authInfo.AccessTokenOptions.html | 2 +- types/org_authInfo.AuthFields.html | 2 +- types/org_authInfo.AuthInfo.Options.html | 2 +- types/org_authInfo.AuthSideEffects.html | 2 +- types/org_authInfo.ConnectionOptions.html | 2 +- types/org_authInfo.JwtOAuth2Config.html | 2 +- types/org_authInfo.OrgAuthorization.html | 2 +- types/org_authInfo.RefreshFn.html | 2 +- types/org_connection.Connection.Options.html | 2 +- .../org_connection.DeployOptionsWithRest.html | 2 +- ...g_connection.SingleRecordQueryOptions.html | 2 +- types/org_org.Org.Options.html | 2 +- types/org_org.OrganizationInformation.html | 2 +- types/org_org.ResultEvent.html | 2 +- types/org_org.ResumeSandboxRequest.html | 2 +- types/org_org.SandboxFields.html | 2 +- types/org_org.SandboxInfo.html | 2 +- types/org_org.SandboxProcessObject.html | 2 +- types/org_org.SandboxRequest.html | 2 +- types/org_org.SandboxUserAuthRequest.html | 2 +- types/org_org.SandboxUserAuthResponse.html | 2 +- types/org_org.ScratchOrgRequest.html | 2 +- types/org_org.StatusEvent.html | 2 +- ...ignment.PermissionSetAssignmentFields.html | 2 +- types/org_scratchOrgCache.CachedOptions.html | 2 +- ...atchOrgCreate.ScratchOrgCreateOptions.html | 2 +- ...ratchOrgCreate.ScratchOrgCreateResult.html | 2 +- ...rgInfoGenerator.ScratchOrgInfoPayload.html | 2 +- ...ecycleEvents.ScratchOrgLifecycleEvent.html | 2 +- ...ratchOrgSettingsGenerator.PackageFile.html | 2 +- ...ratchOrgSettingsGenerator.SettingType.html | 2 +- types/org_scratchOrgTypes.ObjectSetting.html | 2 +- types/org_scratchOrgTypes.ScratchOrgInfo.html | 2 +- types/org_user.DefaultUserFields.Options.html | 2 +- types/org_user.PasswordConditions.html | 2 +- types/org_user.User.Options.html | 2 +- types/org_user.UserFields.html | 2 +- types/sfError.SfErrorOptions.html | 2 +- types/sfProject.NamedPackageDir.html | 2 +- types/sfProject.NamedPackagingDir.html | 2 +- types/sfProject.ProjectJson.html | 2 +- ...tor_accessors_aliasAccessor.Aliasable.html | 2 +- ...mainResolver.MyDomainResolver.Options.html | 2 +- ...s_pollingClient.PollingClient.Options.html | 2 +- ...us_streamingClient.StreamingClientIfc.html | 2 +- types/status_types.Callback.html | 2 +- types/status_types.CometSubscription.html | 2 +- types/status_types.Message.html | 2 +- types/status_types.StatusResult.html | 2 +- types/status_types.StreamProcessor.html | 2 +- types/status_types.StreamingExtension.html | 2 +- types/testSetup.ConfigStub.html | 2 +- types/testSetup.SandboxTypes.html | 2 +- ...StreamingMockCometSubscriptionOptions.html | 2 +- ...til_structuredWriter.StructuredWriter.html | 2 +- ...webOAuthServer.WebOAuthServer.Options.html | 2 +- ...webOAuthServer.WebOAuthServer.Request.html | 2 +- ...config_config.SFDX_ALLOWED_PROPERTIES.html | 2 +- .../config_config.SF_ALLOWED_PROPERTIES.html | 2 +- variables/config_config.SfProperty.html | 2 +- .../config_envVars.SUPPORTED_ENV_VARS.html | 2 +- variables/config_envVars.envVars-1.html | 2 +- .../config_lwwMap.SYMBOL_FOR_DELETED.html | 2 +- variables/logger_filters.HIDDEN.html | 2 +- ...g_authInfo.DEFAULT_CONNECTED_APP_INFO.html | 2 +- variables/org_connection.DNS_ERROR_NAME.html | 2 +- .../org_connection.SFDX_HTTP_HEADERS.html | 2 +- ...rg_connection.SingleRecordQueryErrors.html | 2 +- ...perties.ORG_CONFIG_ALLOWED_PROPERTIES.html | 2 +- ...Create.DEFAULT_STREAM_TIMEOUT_MINUTES.html | 2 +- ...leEvents.scratchOrgLifecycleEventName.html | 2 +- ...cycleEvents.scratchOrgLifecycleStages.html | 2 +- variables/org_user.REQUIRED_FIELDS.html | 2 +- ...accessors_aliasAccessor.DEFAULT_GROUP.html | 2 +- ...ator_accessors_aliasAccessor.FILENAME.html | 2 +- variables/testSetup.unexpectedResult.html | 2 +- variables/util_internal.traverse.html | 2 +- .../util_lockRetryOptions.lockOptions.html | 2 +- ...til_lockRetryOptions.lockRetryOptions.html | 2 +- variables/util_sfdc.accessTokenRegex.html | 2 +- variables/util_sfdc.sfdxAuthUrlRegex.html | 2 +- 333 files changed, 1113 insertions(+), 1113 deletions(-) diff --git a/classes/config_authInfoConfig.AuthInfoConfig.html b/classes/config_authInfoConfig.AuthInfoConfig.html index e66dd672d..8448eed04 100644 --- a/classes/config_authInfoConfig.AuthInfoConfig.html +++ b/classes/config_authInfoConfig.AuthInfoConfig.html @@ -2,7 +2,7 @@ in the global sfdx directory (~/.sfdx).

const authInfo = await AuthInfoConfig.create(AuthInfoConfig.getOptions(username));
 
-

Hierarchy (view full)

Methods

Hierarchy (view full)

Methods

access accessSync clear entries @@ -40,86 +40,86 @@ by perm.

Parameters

Returns Promise<boolean>

  • Determines if the config file is read/write accessible. Returns true if the user has capabilities specified +

Returns Promise<boolean>

  • Check to see if the config file exists. Returns true if the config file exists and has access, false otherwise.

    -

    Returns Promise<boolean>

  • Invokes actionFn once for each key-value pair present in the config object.

    +

Returns boolean

  • Check to see if the config file exists. Returns true if the config file exists and has access, false otherwise.

    +

    Returns Promise<boolean>

  • Invokes actionFn once for each key-value pair present in the config object.

    Parameters

    • actionFn: ((key, value) => void)

      The function (key: string, value: ConfigValue) => void to be called for each element.

      -
        • (key, value): void
        • Parameters

          • key: string
          • value: AnyJson

          Returns void

    Returns void

  • Returns the value associated to the key, or undefined if there is none.

    +
      • (key, value): void
      • Parameters

        • key: string
        • value: AnyJson

        Returns void

Returns void

  • Returns the entire config contents.

    +

Returns AuthFields[K]

  • Type Parameters

    • V = AnyJson

    Parameters

    • key: string
    • Optional decrypt: boolean

    Returns V

    • Returns the entire config contents.

      NOTE: Data will still be encrypted unless decrypt is passed in. A clone of the data will be returned to prevent storing un-encrypted data in memory and potentially saving to the file system.

      -

      Parameters

      • decrypt: boolean = false

      Returns Readonly<AuthFields>

    • Returns the absolute path to the config file.

      +

    Returns (keyof AuthFields)[]

    • Returns the absolute path to the config file.

      The first time getPath is called, the path is resolved and becomes immutable. This allows implementers to override options properties, like filePath, on the init method for async creation. If that is required for creation, the config files can not be synchronously created.

      -

      Returns string

    • Returns a boolean asserting whether a value has been associated to the key in the config object or not.

      -

      Parameters

      • key: string

      Returns boolean

    • Returns a boolean asserting whether a value has been associated to the key in the config object or not.

      +

      Parameters

      • key: string

      Returns boolean

    • Read the config file and set the config contents. Returns the config contents of the config file. As an optimization, files are only read once per process and updated in memory and via write(). To force a read from the filesystem pass force=true. Throws SfError{ name: 'UnexpectedJsonFileFormat' } There was a problem reading or parsing the file.

      Parameters

      • Optional throwOnNotFound: boolean = false

        Optionally indicate if a throw should occur on file read.

      • Optional force: boolean = false

        Optionally force the file to be read from disk even when already read within the process.

        -

      Returns Promise<AuthFields>

    • Read the config file and set the config contents. Returns the config contents of the config file. As an +

    Returns Promise<AuthFields>

    • Read the config file and set the config contents. Returns the config contents of the config file. As an optimization, files are only read once per process and updated in memory and via write(). To force a read from the filesystem pass force=true. Throws SfError{ name: 'UnexpectedJsonFileFormat' } There was a problem reading or parsing the file.

      Parameters

      • Optional throwOnNotFound: boolean = false

        Optionally indicate if a throw should occur on file read.

      • Optional force: boolean = false

        Optionally force the file to be read from disk even when already read within the process.

        -

      Returns AuthFields

    • Sets the value for the key in the config object. This will override the existing value. +

    Returns AuthFields

    • Sets the value for the key in the config object. This will override the existing value. To do a partial update, use BaseConfigStore.update.

      Type Parameters

      Parameters

      Returns void

    • Convert an object to a ConfigContents and set it as the config contents.

      +

    Returns void

    • Get the stats of the file. Returns the stats of the file.

      +

    Returns void

    • Delete the config file if it exists.

      Throws Error{ name: 'TargetFileNotFound' } If the ConfigFile.getFilename file is not found. fs.unlink

      -

      Returns Promise<void>

    • Delete the config file if it exists.

      Throws Error{ name: 'TargetFileNotFound' } If the ConfigFile.getFilename file is not found. fs.unlink

      -

      Returns void

    • Returns true if an element in the config object existed and has been removed, or false if the element does not exist. BaseConfigStore.has will return false afterwards.

      Type Parameters

      Parameters

      • key: K

        The key

        -

      Returns boolean

    • Returns true if all elements in the config object existed and have been removed, or false if all the elements +

    Returns boolean

    • Returns true if all elements in the config object existed and have been removed, or false if all the elements do not exist (some may have been removed). BaseConfigStore.has(key) will return false afterwards.

      Parameters

      Returns boolean

    • Updates the value for the key in the config object. If the value is an object, it +

    Returns boolean

    • Updates the value for the key in the config object. If the value is an object, it will be merged with the existing object.

      Type Parameters

      Parameters

      Returns void

    • Write the config file with new contents. If no new contents are provided it will write the existing config +

    Returns void

    • Write the config file with new contents. If no new contents are provided it will write the existing config contents that were set from ConfigFile.read, or an empty file if ConfigFile.read was not called.

      -

      Returns Promise<AuthFields>

    • Gets the config options for a given org ID.

      +

    Returns ConfigFile.Options

    • Helper used to determine what the local and global folder point to. Returns the file path of the root folder.

      +

    Returns ConfigFile.Options

    • Helper used to determine what the local and global folder point to. Returns the file path of the root folder.

      Parameters

      • isGlobal: boolean

        True if the config should be global. False for local.

        -

      Returns Promise<string>

    • Helper used to determine what the local and global folder point to. Returns the file path of the root folder.

      +

    Returns Promise<string>

    • Helper used to determine what the local and global folder point to. Returns the file path of the root folder.

      Parameters

      • isGlobal: boolean

        True if the config should be global. False for local.

        -

      Returns string

    \ No newline at end of file +

    Returns string

    \ No newline at end of file diff --git a/classes/config_config.Config.html b/classes/config_config.Config.html index c42107773..b4253960d 100644 --- a/classes/config_config.Config.html +++ b/classes/config_config.Config.html @@ -4,7 +4,7 @@
    const localConfig = await Config.create();
    localConfig.set('target-org', 'username@company.org');
    await localConfig.write();

    https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_cli_config_values.htm

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Methods

    • Determines if the config file is read/write accessible. Returns true if the user has capabilities specified +

    Constructors

    Methods

    • Determines if the config file is read/write accessible. Returns true if the user has capabilities specified +

    Returns Promise<boolean>

    • Check to see if the config file exists. Returns true if the config file exists and has access, false otherwise.

      -

      Returns Promise<boolean>

    • Invokes actionFn once for each key-value pair present in the config object.

      +

    Returns boolean

    • Check to see if the config file exists. Returns true if the config file exists and has access, false otherwise.

      +

      Returns Promise<boolean>

    • Invokes actionFn once for each key-value pair present in the config object.

      Parameters

      • actionFn: ((key, value) => void)

        The function (key: string, value: ConfigValue) => void to be called for each element.

        -
          • (key, value): void
          • Parameters

            • key: string
            • value: AnyJson

            Returns void

      Returns void

    • Returns the value associated to the key, or undefined if there is none.

      +
        • (key, value): void
        • Parameters

          • key: string
          • value: AnyJson

          Returns void

    Returns void

    • Returns the value associated to the key, or undefined if there is none.

      Type Parameters

      • K extends string

      Parameters

      • key: K

        The key (object property)

      • Optional decrypt: boolean

        If it is an encrypted key, decrypt the value. If the value is an object, a clone will be returned.

        -

      Returns Optional<AnyJson>

    • Type Parameters

      • V = AnyJson

      Parameters

      • key: string
      • Optional decrypt: boolean

      Returns V

    • Returns the entire config contents.

      +

    Returns Optional<AnyJson>

  • Type Parameters

    • V = AnyJson

    Parameters

    • key: string
    • Optional decrypt: boolean

    Returns V

    • Returns the entire config contents.

      NOTE: Data will still be encrypted unless decrypt is passed in. A clone of the data will be returned to prevent storing un-encrypted data in memory and potentially saving to the file system.

      -

      Parameters

      • decrypt: boolean = false

      Returns Readonly<ConfigProperties>

    • Returns the absolute path to the config file.

      +

    Returns string[]

    • Returns the absolute path to the config file.

      The first time getPath is called, the path is resolved and becomes immutable. This allows implementers to override options properties, like filePath, on the init method for async creation. If that is required for creation, the config files can not be synchronously created.

      -

      Returns string

    • Get an individual property config.

      Throws SfError{ name: 'UnknownConfigKeyError' } An attempt to get a property that's not supported.

      Parameters

      • propertyName: string

        The name of the property.

        -

      Returns ConfigPropertyMeta

    • Returns a boolean asserting whether a value has been associated to the key in the config object or not.

      -

      Parameters

      • key: string

      Returns boolean

    • Read the config file and set the config contents. Returns the config contents of the config file. As an +

    Returns ConfigPropertyMeta

    • Returns a boolean asserting whether a value has been associated to the key in the config object or not.

      +

      Parameters

      • key: string

      Returns boolean

    • Read the config file and set the config contents. Returns the config contents of the config file. As an optimization, files are only read once per process and updated in memory and via write(). To force a read from the filesystem pass force=true. Throws SfError{ name: 'UnexpectedJsonFileFormat' } There was a problem reading or parsing the file.

      Parameters

      • force: boolean = true

        Optionally indicate if a throw should occur on file read.

        -

      Returns ConfigProperties

    Returns ConfigProperties

    • Sets a value for a property.

      Throws SfError{ name: 'UnknownConfigKeyError' } An attempt to get a property that's not supported. Throws SfError{ name: 'InvalidConfigValueError' } If the input validator fails.

      Type Parameters

      • K extends string

      Parameters

      • key: K

        The property to set.

      • value: Optional<AnyJson>

        The value of the property.

        -

      Returns ConfigProperties

    • Convert an object to a ConfigContents and set it as the config contents.

      +

    Returns ConfigProperties

    • Get the stats of the file. Returns the stats of the file.

      +

    Returns void

    • Delete the config file if it exists.

      Throws Error{ name: 'TargetFileNotFound' } If the ConfigFile.getFilename file is not found. fs.unlink

      -

      Returns Promise<void>

    • Delete the config file if it exists.

      Throws Error{ name: 'TargetFileNotFound' } If the ConfigFile.getFilename file is not found. fs.unlink

      -

      Returns void

    • Unsets a value for a property.

      Throws SfError{ name: 'UnknownConfigKeyError' } If the input validator fails.

      Parameters

      • key: string

        The property to unset.

        -

      Returns boolean

    • Returns true if all elements in the config object existed and have been removed, or false if all the elements +

    Returns boolean

    • Returns true if all elements in the config object existed and have been removed, or false if all the elements do not exist (some may have been removed). BaseConfigStore.has(key) will return false afterwards.

      Parameters

      • keys: string[]

        The keys

        -

      Returns boolean

    • Updates the value for the key in the config object. If the value is an object, it +

    Returns boolean

    • Updates the value for the key in the config object. If the value is an object, it will be merged with the existing object.

      Type Parameters

      • K extends string

      Parameters

      • key: K

        The key.

      • value: Partial<Optional<AnyJson>>

        The value.

        -

      Returns void

    • DO NOT CALL - The config file needs to encrypt values which can only be done asynchronously. +

    Returns void

    • Add an array of allowed config properties.

      +

    Returns ConfigProperties

    • Add an array of allowed config properties.

      Parameters

      Returns void

    • Clear all the configured properties both local and global.

      -

      Returns Promise<void>

    • Returns the default options for the config file.

      +

    Returns void

    • Clear all the configured properties both local and global.

      +

      Returns Promise<void>

    • Returns the default file name for a config file.

      +

    Returns ConfigFile.Options

    • Helper used to determine what the local and global folder point to. Returns the file path of the root folder.

      +

      Returns string

    • Helper used to determine what the local and global folder point to. Returns the file path of the root folder.

      Parameters

      • isGlobal: boolean

        True if the config should be global. False for local.

        -

      Returns Promise<string>

    • Helper used to determine what the local and global folder point to. Returns the file path of the root folder.

      +

    Returns Promise<string>

    • Helper used to determine what the local and global folder point to. Returns the file path of the root folder.

      Parameters

      • isGlobal: boolean

        True if the config should be global. False for local.

        -

      Returns string

    • The value of a supported config property.

      +

    Returns string

    • The value of a supported config property.

      Type Parameters

      • K extends string

      Parameters

      • isGlobal: boolean

        True for a global config. False for a local config.

      • propertyName: K

        The name of the property to set.

      • Optional value: Optional<AnyJson>

        The property value.

        -

      Returns Promise<ConfigContents>

    \ No newline at end of file +

    Returns Promise<ConfigContents>

    \ No newline at end of file diff --git a/classes/config_configAggregator.ConfigAggregator-1.html b/classes/config_configAggregator.ConfigAggregator-1.html index 49af4d6bd..76e854d4f 100644 --- a/classes/config_configAggregator.ConfigAggregator-1.html +++ b/classes/config_configAggregator.ConfigAggregator-1.html @@ -8,7 +8,7 @@

    Use ConfigAggregator.create to instantiate the aggregator.

    const aggregator = await ConfigAggregator.create();
    console.log(aggregator.getPropertyValue('target-org'));
    -

    Hierarchy

    Methods

    Hierarchy

    Methods

    • Get all resolved config property keys, values, locations, and paths.

      > console.log(aggregator.getConfigInfo());
      [
      { key: 'logLevel', val: 'INFO', location: 'Environment', path: '$SF_LOG_LEVEL'}
      { key: 'target-org', val: '<username>', location: 'Local', path: './.sf/config.json'}
      ]
      -

      Returns ConfigInfo[]

    • Get a resolved config property. If a property is deprecated, it will try to use the the new key, if there is a config there.

      Parameters

      • key: string

        The key of the property.

      • throwOnDeprecation: boolean = false

        True, if you want an error throw when reading a deprecated config

        -

      Returns ConfigInfo

    • Gets a resolved config property location.

      +

    Returns ConfigInfo

    • Gets a resolved config property location.

      For example, getLocation('logLevel') will return:

      1. Location.GLOBAL if resolved to an environment variable.
      2. @@ -44,7 +44,7 @@
      3. Location.ENVIRONMENT if resolved to the global config.

      Parameters

      • key: string

        The key of the property.

        -

      Returns Optional<Location>

    • Get a resolved file path or environment variable name of the property.

      +

    Returns Optional<Location>

    • Get a resolved file path or environment variable name of the property.

      For example, getPath('logLevel') will return:

      1. $SF_LOG_LEVEL if resolved to an environment variable.
      2. @@ -55,17 +55,17 @@

        Note: that the path returned may be the absolute path instead of relative paths such as ./ and ~/.

      Parameters

      • key: string

        The key of the property.

        -

      Returns Optional<string>

    Returns Optional<string>

    • Get a resolved config property meta. If the property is deprecated, it will return the new key's meta, if it exists, with a deprecation warning

      Throws SfError{ name: 'UnknownConfigKeyError' } An attempt to get a property that's not supported.

      Parameters

      • key: string

        The key of the property.

        -

      Returns ConfigPropertyMeta

    • Get a resolved config property. +

    Returns ConfigPropertyMeta

    • Get a resolved config property. If you use a deprecated property, a warning will be emitted and it will attempt to resolve the new property's value

      Throws SfError{ name: 'UnknownConfigKeyError' } An attempt to get a property that's not supported.

      Type Parameters

      • T extends AnyJson

      Parameters

      • key: string

        The key of the property.

        -

      Returns Optional<T>

    • Initialize this instances async dependencies.

      -

      Returns Promise<void>

    • Type Parameters

      Parameters

      • this: (new (options?) => T)
          • new (options?): T
          • Parameters

            • Optional options: P

            Returns T

      • Optional options: P

      Returns Promise<T>

    • Get the info for a given key. If the ConfigAggregator was not asynchronously created OR +

    Returns Optional<T>

    • Initialize this instances async dependencies.

      +

      Returns Promise<void>

    • Type Parameters

      Parameters

      • this: (new (options?) => T)
          • new (options?): T
          • Parameters

            • Optional options: P

            Returns T

      • Optional options: P

      Returns Promise<T>

    \ No newline at end of file +

    Returns ConfigInfo

    \ No newline at end of file diff --git a/classes/config_configFile.ConfigFile-1.html b/classes/config_configFile.ConfigFile-1.html index 79efed55b..45898148c 100644 --- a/classes/config_configFile.ConfigFile-1.html +++ b/classes/config_configFile.ConfigFile-1.html @@ -4,7 +4,7 @@ specified.

    class MyConfig extends ConfigFile {
    public static getFileName(): string {
    return 'myConfigFilename.json';
    }
    }
    const myConfig = await MyConfig.create({
    isGlobal: true
    });
    myConfig.set('mykey', 'myvalue');
    await myConfig.write();
    -

    Type Parameters

    Hierarchy (view full)

    Methods

    Type Parameters

    Hierarchy (view full)

    Methods

    access accessSync clear entries @@ -41,84 +41,84 @@ by perm.

    Parameters

    Returns Promise<boolean>

    • Determines if the config file is read/write accessible. Returns true if the user has capabilities specified +

    Returns Promise<boolean>

    • Check to see if the config file exists. Returns true if the config file exists and has access, false otherwise.

      -

      Returns Promise<boolean>

    • Check to see if the config file exists. Returns true if the config file exists and has access, false otherwise.

      -

      Returns boolean

    • Invokes actionFn once for each key-value pair present in the config object.

      +

    Returns boolean

    • Check to see if the config file exists. Returns true if the config file exists and has access, false otherwise.

      +

      Returns Promise<boolean>

    • Check to see if the config file exists. Returns true if the config file exists and has access, false otherwise.

      +

      Returns boolean

    • Invokes actionFn once for each key-value pair present in the config object.

      Parameters

      • actionFn: ((key, value) => void)

        The function (key: string, value: ConfigValue) => void to be called for each element.

        -
          • (key, value): void
          • Parameters

            • key: string
            • value: AnyJson

            Returns void

      Returns void

    • Returns the value associated to the key, or undefined if there is none.

      +
        • (key, value): void
        • Parameters

          • key: string
          • value: AnyJson

          Returns void

    Returns void

    • Returns the value associated to the key, or undefined if there is none.

      Type Parameters

      • K extends string

      Parameters

      • key: K

        The key (object property)

      • Optional decrypt: boolean

        If it is an encrypted key, decrypt the value. If the value is an object, a clone will be returned.

        -

      Returns P[K]

    • Type Parameters

      • V = AnyJson

      Parameters

      • key: string
      • Optional decrypt: boolean

      Returns V

    • Returns the entire config contents.

      +

    Returns P[K]

  • Type Parameters

    • V = AnyJson

    Parameters

    • key: string
    • Optional decrypt: boolean

    Returns V

    • Returns the entire config contents.

      NOTE: Data will still be encrypted unless decrypt is passed in. A clone of the data will be returned to prevent storing un-encrypted data in memory and potentially saving to the file system.

      -

      Parameters

      • decrypt: boolean = false

      Returns Readonly<P>

    • Returns the absolute path to the config file.

      +

    Returns Extract<keyof P, string>[]

    • Returns the absolute path to the config file.

      The first time getPath is called, the path is resolved and becomes immutable. This allows implementers to override options properties, like filePath, on the init method for async creation. If that is required for creation, the config files can not be synchronously created.

      -

      Returns string

    • Returns true if this config is using the global path, false otherwise.

      -

      Returns boolean

    • Read the config file and set the config contents. Returns the config contents of the config file. As an +

      Returns string

    • Returns true if this config is using the global path, false otherwise.

      +

      Returns boolean

    • Read the config file and set the config contents. Returns the config contents of the config file. As an optimization, files are only read once per process and updated in memory and via write(). To force a read from the filesystem pass force=true. Throws SfError{ name: 'UnexpectedJsonFileFormat' } There was a problem reading or parsing the file.

      Parameters

      • Optional throwOnNotFound: boolean = false

        Optionally indicate if a throw should occur on file read.

      • Optional force: boolean = false

        Optionally force the file to be read from disk even when already read within the process.

        -

      Returns Promise<P>

    • Read the config file and set the config contents. Returns the config contents of the config file. As an +

    Returns Promise<P>

    • Read the config file and set the config contents. Returns the config contents of the config file. As an optimization, files are only read once per process and updated in memory and via write(). To force a read from the filesystem pass force=true. Throws SfError{ name: 'UnexpectedJsonFileFormat' } There was a problem reading or parsing the file.

      Parameters

      • Optional throwOnNotFound: boolean = false

        Optionally indicate if a throw should occur on file read.

      • Optional force: boolean = false

        Optionally force the file to be read from disk even when already read within the process.

        -

      Returns P

    • Sets the value for the key in the config object. This will override the existing value. +

    Returns P

    • Sets the value for the key in the config object. This will override the existing value. To do a partial update, use BaseConfigStore.update.

      Type Parameters

      • K extends string

      Parameters

      • key: K

        The key.

      • value: P[K]

        The value.

        -

      Returns void

    • Convert an object to a ConfigContents and set it as the config contents.

      +

    Returns void

    • Get the stats of the file. Returns the stats of the file.

      +

    Returns void

    • Get the stats of the file. Returns the stats of the file.

      fs.stat

      -

      Returns Promise<Stats>

    • Convert the config object to a JSON object. Returns the config contents. +

      Returns Stats

    • Delete the config file if it exists.

      Throws Error{ name: 'TargetFileNotFound' } If the ConfigFile.getFilename file is not found. fs.unlink

      -

      Returns Promise<void>

    • Delete the config file if it exists.

      Throws Error{ name: 'TargetFileNotFound' } If the ConfigFile.getFilename file is not found. fs.unlink

      -

      Returns void

    • Returns true if an element in the config object existed and has been removed, or false if the element does not +

      Returns void

    • Returns true if an element in the config object existed and has been removed, or false if the element does not exist. BaseConfigStore.has will return false afterwards.

      Type Parameters

      • K extends string

      Parameters

      • key: K

        The key

        -

      Returns boolean

    • Returns true if all elements in the config object existed and have been removed, or false if all the elements +

    Returns boolean

    • Returns true if all elements in the config object existed and have been removed, or false if all the elements do not exist (some may have been removed). BaseConfigStore.has(key) will return false afterwards.

      Parameters

      • keys: Extract<keyof P, string>[]

        The keys

        -

      Returns boolean

    • Updates the value for the key in the config object. If the value is an object, it +

    Returns boolean

    • Updates the value for the key in the config object. If the value is an object, it will be merged with the existing object.

      Type Parameters

      • K extends string

      Parameters

      • key: K

        The key.

      • value: Partial<P[K]>

        The value.

        -

      Returns void

    • Write the config file with new contents. If no new contents are provided it will write the existing config +

    Returns void

    • Write the config file with new contents. If no new contents are provided it will write the existing config +

      Returns Promise<P>

    • Returns the default options for the config file.

      Parameters

      • isGlobal: boolean = false

        If the file should be stored globally or locally.

      • Optional filename: string

        The name of the config file.

        -

      Returns ConfigFile.Options

    • Helper used to determine what the local and global folder point to. Returns the file path of the root folder.

      +

    Returns ConfigFile.Options

    • Helper used to determine what the local and global folder point to. Returns the file path of the root folder.

      Parameters

      • isGlobal: boolean

        True if the config should be global. False for local.

        -

      Returns Promise<string>

    • Helper used to determine what the local and global folder point to. Returns the file path of the root folder.

      +

    Returns Promise<string>

    • Helper used to determine what the local and global folder point to. Returns the file path of the root folder.

      Parameters

      • isGlobal: boolean

        True if the config should be global. False for local.

        -

      Returns string

    \ No newline at end of file +

    Returns string

    \ No newline at end of file diff --git a/classes/config_configStore.BaseConfigStore.html b/classes/config_configStore.BaseConfigStore.html index 532088b5e..6c2dac9ab 100644 --- a/classes/config_configStore.BaseConfigStore.html +++ b/classes/config_configStore.BaseConfigStore.html @@ -1,7 +1,7 @@ BaseConfigStore | @salesforce/core

    Class BaseConfigStore<T, P>Abstract

    An abstract class that implements all the config management functions but none of the storage functions.

    Note: To see the interface, look in typescripts autocomplete help or the npm package's ConfigStore.d.ts file.

    -

    Type Parameters

    Hierarchy (view full)

    Implements

    Methods

    Type Parameters

    Hierarchy (view full)

    Implements

    Methods

    clear entries forEach get @@ -17,38 +17,38 @@ update values

    Methods

    • Removes all key/value pairs from the config object.

      -

      Returns void

    • Invokes actionFn once for each key-value pair present in the config object.

      +

      Returns void

    • Invokes actionFn once for each key-value pair present in the config object.

      Parameters

      • actionFn: ((key, value) => void)

        The function (key: string, value: ConfigValue) => void to be called for each element.

        -
          • (key, value): void
          • Parameters

            • key: string
            • value: AnyJson

            Returns void

      Returns void

    • Returns the value associated to the key, or undefined if there is none.

      +
        • (key, value): void
        • Parameters

          • key: string
          • value: AnyJson

          Returns void

    Returns void

    • Returns the value associated to the key, or undefined if there is none.

      Type Parameters

      • K extends string

      Parameters

      • key: K

        The key (object property)

      • Optional decrypt: boolean

        If it is an encrypted key, decrypt the value. If the value is an object, a clone will be returned.

        -

      Returns P[K]

    • Type Parameters

      • V = AnyJson

      Parameters

      • key: string
      • Optional decrypt: boolean

      Returns V

    • Returns the entire config contents.

      +

    Returns P[K]

  • Type Parameters

    • V = AnyJson

    Parameters

    • key: string
    • Optional decrypt: boolean

    Returns V

    • Returns the entire config contents.

      NOTE: Data will still be encrypted unless decrypt is passed in. A clone of the data will be returned to prevent storing un-encrypted data in memory and potentially saving to the file system.

      -

      Parameters

      • decrypt: boolean = false

      Returns Readonly<P>

    • Returns the list of keys that contain a value.

      +

      Parameters

      • decrypt: boolean = false

      Returns Readonly<P>

    • Returns the list of keys that contain a value.

      Parameters

      • value: AnyJson

        The value to filter keys on.

        -

      Returns Extract<keyof P, string>[]

    • Returns a boolean asserting whether a value has been associated to the key in the config object or not.

      -

      Parameters

      • key: string

      Returns boolean

    • Returns an array that contains the keys for each element in the config object.

      -

      Returns Extract<keyof P, string>[]

    • Sets the value for the key in the config object. This will override the existing value. +

    Returns Extract<keyof P, string>[]

    Returns void

    Returns void

    Returns boolean

    Returns boolean

    \ No newline at end of file +

    Returns void

    \ No newline at end of file diff --git a/classes/config_envVars.EnvVars.html b/classes/config_envVars.EnvVars.html index 8212633b6..234bf25cf 100644 --- a/classes/config_envVars.EnvVars.html +++ b/classes/config_envVars.EnvVars.html @@ -1,6 +1,6 @@ -EnvVars | @salesforce/core

    Hierarchy

    • Env
      • EnvVars

    Constructors

    constructor +EnvVars | @salesforce/core

    Hierarchy

    • Env
      • EnvVars

    Constructors

    Methods

    • Type Parameters

      • T

      Parameters

      • property: string
      • prefix: string = ...

      Returns Nullable<T>

    • Parameters

      • property: string
      • prefix: string = ...

      Returns string

    \ No newline at end of file +

    Constructors

    Methods

    • Type Parameters

      • T

      Parameters

      • property: string
      • prefix: string = ...

      Returns Nullable<T>

    • Parameters

      • property: string
      • prefix: string = ...

      Returns string

    \ No newline at end of file diff --git a/classes/config_lwwMap.LWWMap.html b/classes/config_lwwMap.LWWMap.html index a5075c031..5d0d35c51 100644 --- a/classes/config_lwwMap.LWWMap.html +++ b/classes/config_lwwMap.LWWMap.html @@ -1,4 +1,4 @@ -LWWMap | @salesforce/core

    Type Parameters

    Constructors

    constructor +LWWMap | @salesforce/core

    Type Parameters

    Constructors

    Accessors

    Methods

    delete @@ -6,4 +6,4 @@ has merge set -

    Constructors

    Accessors

    Methods

    \ No newline at end of file +

    Constructors

    Accessors

    Methods

    \ No newline at end of file diff --git a/classes/config_lwwRegister.LWWRegister.html b/classes/config_lwwRegister.LWWRegister.html index 7ded7eaf5..108f44a79 100644 --- a/classes/config_lwwRegister.LWWRegister.html +++ b/classes/config_lwwRegister.LWWRegister.html @@ -1,10 +1,10 @@ LWWRegister | @salesforce/core

    a CRDT implementation. Uses timestamps to resolve conflicts when updating the value (last write wins) mostly based on https://jakelazaroff.com/words/an-interactive-intro-to-crdts/

    Type Parameters

    • T

      the type of the value stored in the register

      -

    Constructors

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    Properties

    state: LWWRegisterState<T>

    Accessors

    Methods

    \ No newline at end of file +

    Constructors

    Properties

    state: LWWRegisterState<T>

    Accessors

    Methods

    \ No newline at end of file diff --git a/classes/config_orgUsersConfig.OrgUsersConfig-1.html b/classes/config_orgUsersConfig.OrgUsersConfig-1.html index d9ff90df4..27550c0eb 100644 --- a/classes/config_orgUsersConfig.OrgUsersConfig-1.html +++ b/classes/config_orgUsersConfig.OrgUsersConfig-1.html @@ -1,5 +1,5 @@ OrgUsersConfig | @salesforce/core

    A config file that stores usernames for an org.

    -

    Hierarchy (view full)

    Methods

    Hierarchy (view full)

    Methods

    access accessSync clear entries @@ -37,86 +37,86 @@ by perm.

    Parameters

    Returns Promise<boolean>

    • Determines if the config file is read/write accessible. Returns true if the user has capabilities specified +

    Returns Promise<boolean>

    • Check to see if the config file exists. Returns true if the config file exists and has access, false otherwise.

      -

      Returns Promise<boolean>

    • Invokes actionFn once for each key-value pair present in the config object.

      +

    Returns boolean

    • Check to see if the config file exists. Returns true if the config file exists and has access, false otherwise.

      +

      Returns Promise<boolean>

    • Invokes actionFn once for each key-value pair present in the config object.

      Parameters

      • actionFn: ((key, value) => void)

        The function (key: string, value: ConfigValue) => void to be called for each element.

        -
          • (key, value): void
          • Parameters

            • key: string
            • value: AnyJson

            Returns void

      Returns void

    • Returns the value associated to the key, or undefined if there is none.

      +
        • (key, value): void
        • Parameters

          • key: string
          • value: AnyJson

          Returns void

    Returns void

    • Returns the value associated to the key, or undefined if there is none.

      Type Parameters

      • K extends "usernames"

      Parameters

      • key: K

        The key (object property)

      • Optional decrypt: boolean

        If it is an encrypted key, decrypt the value. If the value is an object, a clone will be returned.

        -

      Returns UserConfig[K]

    • Type Parameters

      • V = AnyJson

      Parameters

      • key: string
      • Optional decrypt: boolean

      Returns V

    • Returns the entire config contents.

      +

    Returns UserConfig[K]

  • Type Parameters

    • V = AnyJson

    Parameters

    • key: string
    • Optional decrypt: boolean

    Returns V

  • Returns "usernames"[]

    Returns Promise<UserConfig>

    Returns UserConfig

    Returns void

    Returns void

    Returns boolean

    Returns boolean

    Returns void

    Returns ConfigFile.Options

    Returns OrgUsersConfig.Options

    Returns Promise<string>

    \ No newline at end of file +

    Returns string

    \ No newline at end of file diff --git a/classes/config_sandboxOrgConfig.SandboxOrgConfig-1.html b/classes/config_sandboxOrgConfig.SandboxOrgConfig-1.html index e08422881..9bc8d6b70 100644 --- a/classes/config_sandboxOrgConfig.SandboxOrgConfig-1.html +++ b/classes/config_sandboxOrgConfig.SandboxOrgConfig-1.html @@ -1,5 +1,5 @@ SandboxOrgConfig | @salesforce/core

    A config file that stores usernames for an org.

    -

    Hierarchy (view full)

    Methods

    Hierarchy (view full)

    Methods

    access accessSync clear entries @@ -37,86 +37,86 @@ by perm.

    Parameters

    Returns Promise<boolean>

    • Determines if the config file is read/write accessible. Returns true if the user has capabilities specified +

    Returns Promise<boolean>

    • Check to see if the config file exists. Returns true if the config file exists and has access, false otherwise.

      -

      Returns Promise<boolean>

    • Invokes actionFn once for each key-value pair present in the config object.

      +

    Returns boolean

    • Check to see if the config file exists. Returns true if the config file exists and has access, false otherwise.

      +

      Returns Promise<boolean>

    • Invokes actionFn once for each key-value pair present in the config object.

      Parameters

      • actionFn: ((key, value) => void)

        The function (key: string, value: ConfigValue) => void to be called for each element.

        -
          • (key, value): void
          • Parameters

            • key: string
            • value: AnyJson

            Returns void

      Returns void

    • Returns the value associated to the key, or undefined if there is none.

      +
        • (key, value): void
        • Parameters

          • key: string
          • value: AnyJson

          Returns void

    Returns void

    • Returns the value associated to the key, or undefined if there is none.

      Type Parameters

      • K extends string

      Parameters

      • key: K

        The key (object property)

      • Optional decrypt: boolean

        If it is an encrypted key, decrypt the value. If the value is an object, a clone will be returned.

        -

      Returns Optional<AnyJson>

    • Type Parameters

      • V = AnyJson

      Parameters

      • key: string
      • Optional decrypt: boolean

      Returns V

    • Returns the entire config contents.

      +

    Returns Optional<AnyJson>

  • Type Parameters

    • V = AnyJson

    Parameters

    • key: string
    • Optional decrypt: boolean

    Returns V

  • Returns string[]

    Returns Promise<ConfigContents>

    Returns ConfigContents

    Returns void

    Returns void

    Returns boolean

    Returns boolean

    Returns void

    Returns ConfigFile.Options

    Returns SandboxOrgConfig.Options

    Returns Promise<string>

    \ No newline at end of file +

    Returns string

    \ No newline at end of file diff --git a/classes/config_sandboxProcessCache.SandboxRequestCache.html b/classes/config_sandboxProcessCache.SandboxRequestCache.html index 899adfbd7..00323f06f 100644 --- a/classes/config_sandboxProcessCache.SandboxRequestCache.html +++ b/classes/config_sandboxProcessCache.SandboxRequestCache.html @@ -1,7 +1,7 @@ SandboxRequestCache | @salesforce/core

    A Time To Live configuration file where each entry is timestamped and removed once the TTL has expired.

    Example

    import { Duration } from '@salesforce/kit';
    const config = await TTLConfig.create({
    isGlobal: false,
    ttl: Duration.days(1)
    });
    -

    Hierarchy (view full)

    Methods

    Hierarchy (view full)

    Methods

    access accessSync clear entries @@ -43,82 +43,82 @@ by perm.

    Parameters

    Returns Promise<boolean>

    • Determines if the config file is read/write accessible. Returns true if the user has capabilities specified +

    Returns Promise<boolean>

    • Check to see if the config file exists. Returns true if the config file exists and has access, false otherwise.

      -

      Returns Promise<boolean>

    • Invokes actionFn once for each key-value pair present in the config object.

      +

    Returns boolean

    • Check to see if the config file exists. Returns true if the config file exists and has access, false otherwise.

      +

      Returns Promise<boolean>

    • Invokes actionFn once for each key-value pair present in the config object.

      Parameters

      • actionFn: ((key, value) => void)

        The function (key: string, value: ConfigValue) => void to be called for each element.

        -
          • (key, value): void
          • Parameters

            • key: string
            • value: AnyJson

            Returns void

      Returns void

    • Returns the value associated to the key, or undefined if there is none.

      +
        • (key, value): void
        • Parameters

          • key: string
          • value: AnyJson

          Returns void

    Returns void

    Returns Entry<SandboxRequestCacheEntry>

  • Type Parameters

    • V = AnyJson

    Parameters

    • key: string
    • Optional decrypt: boolean

    Returns V

  • Returns string[]

    Returns Promise<Contents<SandboxRequestCacheEntry>>

    Returns Contents<SandboxRequestCacheEntry>

    Returns void

    Returns void

    Returns boolean

    Returns boolean

    Returns void

    Returns Promise<string>

    \ No newline at end of file +

    Returns string

    \ No newline at end of file diff --git a/classes/config_ttlConfig.TTLConfig-1.html b/classes/config_ttlConfig.TTLConfig-1.html index 1f881f08f..038a8a0f2 100644 --- a/classes/config_ttlConfig.TTLConfig-1.html +++ b/classes/config_ttlConfig.TTLConfig-1.html @@ -1,7 +1,7 @@ TTLConfig | @salesforce/core

    A Time To Live configuration file where each entry is timestamped and removed once the TTL has expired.

    Example

    import { Duration } from '@salesforce/kit';
    const config = await TTLConfig.create({
    isGlobal: false,
    ttl: Duration.days(1)
    });
    -

    Type Parameters

    Hierarchy (view full)

    Methods

    Type Parameters

    Hierarchy (view full)

    Methods

    access accessSync clear entries @@ -41,84 +41,84 @@ by perm.

    Parameters

    Returns Promise<boolean>

    • Determines if the config file is read/write accessible. Returns true if the user has capabilities specified +

    Returns Promise<boolean>

    • Check to see if the config file exists. Returns true if the config file exists and has access, false otherwise.

      -

      Returns Promise<boolean>

    • Invokes actionFn once for each key-value pair present in the config object.

      +

    Returns boolean

    • Check to see if the config file exists. Returns true if the config file exists and has access, false otherwise.

      +

      Returns Promise<boolean>

    • Invokes actionFn once for each key-value pair present in the config object.

      Parameters

      • actionFn: ((key, value) => void)

        The function (key: string, value: ConfigValue) => void to be called for each element.

        -
          • (key, value): void
          • Parameters

            • key: string
            • value: AnyJson

            Returns void

      Returns void

    • Returns the value associated to the key, or undefined if there is none.

      +
        • (key, value): void
        • Parameters

          • key: string
          • value: AnyJson

          Returns void

    Returns void

    • Returns the value associated to the key, or undefined if there is none.

      Type Parameters

      • K extends string

      Parameters

      • key: K

        The key (object property)

      • Optional decrypt: boolean

        If it is an encrypted key, decrypt the value. If the value is an object, a clone will be returned.

        -

      Returns Entry<P>

    • Type Parameters

      • V = AnyJson

      Parameters

      • key: string
      • Optional decrypt: boolean

      Returns V

    • Returns the entire config contents.

      +

    Returns Entry<P>

  • Type Parameters

    • V = AnyJson

    Parameters

    • key: string
    • Optional decrypt: boolean

    Returns V

  • Returns string[]

    Returns Promise<Contents<P>>

    Returns Contents<P>

    Returns void

    Returns void

    Returns boolean

    Returns boolean

    Returns void

    Returns ConfigFile.Options

    Returns Promise<string>

    \ No newline at end of file +

    Returns string

    \ No newline at end of file diff --git a/classes/crypto_crypto.Crypto.html b/classes/crypto_crypto.Crypto.html index d525086ce..a1f1ec611 100644 --- a/classes/crypto_crypto.Crypto.html +++ b/classes/crypto_crypto.Crypto.html @@ -1,16 +1,16 @@ Crypto | @salesforce/core

    Class for managing encrypting and decrypting private auth information.

    -

    Hierarchy

    • AsyncOptionalCreatable<CryptoOptions>
      • Crypto

    Methods

    Hierarchy

    • AsyncOptionalCreatable<CryptoOptions>
      • Crypto

    Methods

    • Clears the crypto state. This should be called in a finally block.

      -

      Returns void

    • Decrypts text.

      Parameters

      • text: string

        The text to decrypt.

        -

      Returns string

    • Encrypts text. Returns the encrypted string or undefined if no string was passed.

      +

    Returns string

    • Encrypts text. Returns the encrypted string or undefined if no string was passed.

      Parameters

      • text: string

        The text to encrypt.

        -

      Returns string

    • Takes a best guess if the value provided was encrypted by Crypto.encrypt by +

    Returns string

    • Takes a best guess if the value provided was encrypted by Crypto.encrypt by checking the delimiter, tag length, and valid characters.

      Parameters

      • Optional text: string

        The text

      Returns boolean

      true if the text is encrypted, false otherwise.

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/classes/crypto_keyChainImpl.GenericKeychainAccess.html b/classes/crypto_keyChainImpl.GenericKeychainAccess.html index 81c62eb89..31c88b4e1 100644 --- a/classes/crypto_keyChainImpl.GenericKeychainAccess.html +++ b/classes/crypto_keyChainImpl.GenericKeychainAccess.html @@ -1,5 +1,5 @@ GenericKeychainAccess | @salesforce/core

    @@ignore

    -

    Implements

    Constructors

    Implements

    Constructors

    Methods

    Constructors

    Methods

    • Parameters

      • opts: ProgramOpts
      • fn: ((error, password?) => void)
          • (error, password?): void
          • Parameters

            • error: Nullable<Error>
            • Optional password: string

            Returns void

      Returns Promise<void>

    • Parameters

      • opts: ProgramOpts
      • fn: ((error, contents?) => void)
          • (error, contents?): void
          • Parameters

            • error: Nullable<Error>
            • Optional contents: SecretContents

            Returns void

      Returns Promise<void>

    \ No newline at end of file +

    Constructors

    Methods

    • Parameters

      • opts: ProgramOpts
      • fn: ((error, password?) => void)
          • (error, password?): void
          • Parameters

            • error: Nullable<Error>
            • Optional password: string

            Returns void

      Returns Promise<void>

    • Parameters

      • opts: ProgramOpts
      • fn: ((error, contents?) => void)
          • (error, contents?): void
          • Parameters

            • error: Nullable<Error>
            • Optional contents: SecretContents

            Returns void

      Returns Promise<void>

    \ No newline at end of file diff --git a/classes/crypto_secureBuffer.SecureBuffer.html b/classes/crypto_secureBuffer.SecureBuffer.html index b1fb6d555..29862fa10 100644 --- a/classes/crypto_secureBuffer.SecureBuffer.html +++ b/classes/crypto_secureBuffer.SecureBuffer.html @@ -1,16 +1,16 @@ SecureBuffer | @salesforce/core

    Used to store and retrieve a sensitive information in memory. This is not meant for at rest encryption.

    const sString: SecureBuffer<string> = new SecureBuffer();
    sString.consume(secretTextBuffer);
    const value: string = sString.value((buffer: Buffer): string => {
    const password: string = buffer.toString('utf8');
    // doSomething with the password
    // returns something of type <T>
    return testReturnValue;
    });
    -

    Type Parameters

    • T

    Constructors

    Type Parameters

    • T

    Constructors

    Methods

    Constructors

    Methods

    • Consumes a buffer of data that's intended to be secret.

      Parameters

      • buffer: Buffer

        Data to encrypt. The input buffer is overwritten with random data after it's encrypted and assigned internally.

        -

      Returns void

    • Invokes a callback with a decrypted version of the buffer.

      +

    Returns void

    • Invokes a callback with a decrypted version of the buffer.

      Parameters

      • cb: DecipherCallback<T>

        The callback containing the decrypted buffer parameter that returns a desired. typed object. It's important to understand that once the callback goes out of scope the buffer parameters is overwritten with random data. Do not make a copy of this buffer and persist it!

        -

      Returns Optional<T>

    \ No newline at end of file +

    Returns Optional<T>

    \ No newline at end of file diff --git a/classes/deviceOauthService.DeviceOauthService.html b/classes/deviceOauthService.DeviceOauthService.html index bf473edbc..87fef8dcb 100644 --- a/classes/deviceOauthService.DeviceOauthService.html +++ b/classes/deviceOauthService.DeviceOauthService.html @@ -2,14 +2,14 @@

    Usage:

    const oauthConfig = {
    loginUrl: this.flags.instanceurl,
    clientId: this.flags.clientid,
    };
    const deviceOauthService = await DeviceOauthService.create(oauthConfig);
    const loginData = await deviceOauthService.requestDeviceLogin();
    console.log(loginData);
    const approval = await deviceOauthService.awaitDeviceApproval(loginData);
    const authInfo = await deviceOauthService.authorizeAndSave(approval);
    -

    Hierarchy

    Constructors

    Hierarchy

    • AsyncCreatable<OAuth2Config>
      • DeviceOauthService

    Constructors

    Properties

    GRANT_TYPE: string = 'device'
    RESPONSE_TYPE: string = 'device_code'
    SCOPE: string = 'refresh_token web api'

    Methods

    \ No newline at end of file +

    Constructors

    Properties

    GRANT_TYPE: string = 'device'
    RESPONSE_TYPE: string = 'device_code'
    SCOPE: string = 'refresh_token web api'

    Methods

    \ No newline at end of file diff --git a/classes/global.Global.html b/classes/global.Global.html index b968b65fd..4f0876b61 100644 --- a/classes/global.Global.html +++ b/classes/global.Global.html @@ -1,5 +1,5 @@ Global | @salesforce/core

    Global constants, methods, and configuration.

    -

    Constructors

    Constructors

    Properties

    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.

    -
    SF_STATE_FOLDER: ".sf" = '.sf'

    The global folder in which sf state is stored.

    -
    STATE_FOLDER: ".sfdx" = Global.SFDX_STATE_FOLDER

    The preferred global folder in which state is stored.

    -

    Accessors

    • get DIR(): string
    • The full system path to the preferred global state folder

      -

      Returns string

    • get SFDX_DIR(): string
    • The full system path to the global sfdx state folder.

      +
    SFDX_STATE_FOLDER: ".sfdx" = '.sfdx'

    The global folder in which sfdx state is stored.

    +
    SF_STATE_FOLDER: ".sf" = '.sf'

    The global folder in which sf state is stored.

    +
    STATE_FOLDER: ".sfdx" = Global.SFDX_STATE_FOLDER

    The preferred global folder in which state is stored.

    +

    Accessors

    • get DIR(): string
    • The full system path to the preferred global state folder

      +

      Returns string

    • get SF_DIR(): string
    • The full system path to the global sf state folder.

      +

      Returns string

    Methods

    Methods

    • 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

      • Optional dirPath: string

        The directory path to be created within Global.SFDX_DIR.

        -

      Returns Promise<void>

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

      +

    Returns Promise<void>

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

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

      Returns Mode

    \ No newline at end of file +

    Returns Mode

    \ No newline at end of file diff --git a/classes/lifecycleEvents.Lifecycle.html b/classes/lifecycleEvents.Lifecycle.html index e4692f0b5..75694bde7 100644 --- a/classes/lifecycleEvents.Lifecycle.html +++ b/classes/lifecycleEvents.Lifecycle.html @@ -6,7 +6,7 @@ regardless of where in the code that metadata was initiated.

    Example

    // Listen for an event in a plugin hook
    Lifecycle.getInstance().on('deploy-metadata', transformMetadata)

    // Deep in the deploy code, fire the event for all libraries and plugins to hear.
    Lifecycle.getInstance().emit('deploy-metadata', metadataToBeDeployed);

    // if you don't need to await anything
    use `void Lifecycle.getInstance().emit('deploy-metadata', metadataToBeDeployed)` ;
    -

    Properties

    Properties

    telemetryEventName: "telemetry" = 'telemetry'
    warningEventName: "warning" = 'warning'

    Methods

    • Emit a given event, causing all callback functions to be run in the order they were registered

      +

    Properties

    telemetryEventName: "telemetry" = 'telemetry'
    warningEventName: "warning" = 'warning'

    Methods

    • Emit a given event, causing all callback functions to be run in the order they were registered

      Type Parameters

      • T = AnyJson

      Parameters

      • eventName: string

        The name of the event to emit

      • data: T

        The argument to be passed to the callback function

        -

      Returns Promise<void>

    • Emit a telemetry event, causing all callback functions to be run in the order they were registered

      +

    Returns Promise<void>

    • Emit a telemetry event, causing all callback functions to be run in the order they were registered

      Parameters

      • data: AnyJson

        The data to emit

        -

      Returns Promise<void>

    • Emit a warning event, causing all callback functions to be run in the order they were registered

      -

      Parameters

      • warning: string

      Returns Promise<void>

    • Get an array of listeners (callback functions) for a given event

      +

    Returns Promise<void>

    • Emit a warning event, causing all callback functions to be run in the order they were registered

      +

      Parameters

      • warning: string

      Returns Promise<void>

    • Get an array of listeners (callback functions) for a given event

      Parameters

      • eventName: string

        The name of the event to get listeners of

        -

      Returns callback[]

    • Create a new listener for a given event

      +

    Returns callback[]

    • Create a new listener for a given event

      Type Parameters

      • T = AnyJson

      Parameters

      • eventName: string

        The name of the event that is being listened for

      • cb: ((data) => Promise<void>)

        The callback function to run when the event is emitted

          • (data): Promise<void>
          • Parameters

            • data: T

            Returns Promise<void>

      • Optional uniqueListenerIdentifier: string

        A unique identifier for the listener. If a listener with the same identifier is already registered, a new one will not be added

        -

      Returns void

    • Create a listener for the telemetry event

      +

    Returns void

    • Create a listener for the telemetry event

      Parameters

      • cb: ((data) => Promise<void>)

        The callback function to run when the event is emitted

        -
          • (data): Promise<void>
          • Parameters

            • data: Record<string, unknown>

            Returns Promise<void>

      Returns void

    • Create a listener for the warning event

      +
        • (data): Promise<void>
        • Parameters

          • data: Record<string, unknown>

          Returns Promise<void>

    Returns void

    • Create a listener for the warning event

      Parameters

      • cb: ((warning) => Promise<void>)

        The callback function to run when the event is emitted

        -
          • (warning): Promise<void>
          • Parameters

            • warning: string

            Returns Promise<void>

      Returns void

    • Remove all listeners for a given event

      +
        • (warning): Promise<void>
        • Parameters

          • warning: string

          Returns Promise<void>

    Returns void

    • Remove all listeners for a given event

      Parameters

      • eventName: string

        The name of the event to remove listeners of

        -

      Returns void

    • return the package.json version of the sfdx-core library.

      -

      Returns string

    \ No newline at end of file +

    Returns void

    \ No newline at end of file diff --git a/classes/logger_logger.Logger.html b/classes/logger_logger.Logger.html index 3b8bcfdae..4b63be477 100644 --- a/classes/logger_logger.Logger.html +++ b/classes/logger_logger.Logger.html @@ -3,7 +3,7 @@
    // Gets the root sfdx logger
    const logger = await Logger.root();

    // Creates a child logger of the root sfdx logger with custom fields applied
    const childLogger = await Logger.child('myRootChild', {tag: 'value'});

    // Creates a custom logger unaffiliated with the root logger
    const myCustomLogger = new Logger('myCustomLogger');

    // Creates a child of a custom logger unaffiliated with the root logger with custom fields applied
    const myCustomChildLogger = myCustomLogger.child('myCustomChild', {tag: 'value'});

    // get a raw pino logger from the root instance of Logger
    // you can use these to avoid constructing another Logger wrapper class and to get better type support
    const logger = Logger.getRawRootLogger().child({name: 'foo', otherProp: 'bar'});
    logger.info({some: 'stuff'}, 'a message');


    // get a raw pino logger from the current instance
    const childLogger = await Logger.child('myRootChild', {tag: 'value'});
    const logger = childLogger.getRawLogger();

    See https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_dev_cli_log_messages.htm

    -

    Constructors

    Constructors

    Properties

    DEFAULT_LEVEL LEVEL_NAMES ROOT_NAME @@ -33,32 +33,32 @@

    Parameters

    • optionsOrName: string | LoggerOptions

      A set of LoggerOptions or name to use with the default options.

      Throws SfError{ name: 'RedundantRootLoggerError' } More than one attempt is made to construct the root Logger.

      -

    Returns Logger

    Properties

    DEFAULT_LEVEL: WARN = LoggerLevel.WARN

    The default LoggerLevel when constructing new Logger instances.

    -
    LEVEL_NAMES: string[] = ...

    A list of all lower case LoggerLevel names.

    +

    Returns Logger

    Properties

    DEFAULT_LEVEL: WARN = LoggerLevel.WARN

    The default LoggerLevel when constructing new Logger instances.

    +
    LEVEL_NAMES: string[] = ...

    A list of all lower case LoggerLevel names.

    See LoggerLevel

    -
    ROOT_NAME: "sf" = 'sf'

    The name of the root sfdx Logger.

    -

    Methods

    • Add a field to all log lines for this logger. For convenience this object is returned.

      +
    ROOT_NAME: "sf" = 'sf'

    The name of the root sfdx Logger.

    +

    Methods

    • Add a field to all log lines for this logger. For convenience this object is returned.

      Parameters

      • name: string

        The name of the field to add.

      • value: FieldValue

        The value of the field to be logged.

        -

      Returns Logger

    • Create a child logger, typically to add a few log record fields. For convenience this object is returned.

      +

    Returns Logger

    • Create a child logger, typically to add a few log record fields. For convenience this object is returned.

      Parameters

      • name: string

        The name of the child logger that is emitted w/ log line. Will be prefixed with the parent logger name and :

      • fields: Fields = {}

        Additional fields included in all log lines for the child logger.

        -

      Returns Logger

    • Logs at debug level with filtering applied. For convenience this object is returned.

      +

    Returns Logger

    • Logs at debug level with filtering applied. For convenience this object is returned.

      Parameters

      • Rest ...args: unknown[]

        Any number of arguments to be logged.

        -

      Returns Logger

    • Logs at debug level with filtering applied.

      +

    Returns Logger

    • Logs at debug level with filtering applied.

      Parameters

      • cb: (() => string | unknown[])

        A callback that returns on array objects to be logged.

        -
          • (): string | unknown[]
          • Returns string | unknown[]

      Returns void

    • Logs at error level with filtering applied. For convenience this object is returned.

      +
        • (): string | unknown[]
        • Returns string | unknown[]

    Returns void

    • Logs at error level with filtering applied. For convenience this object is returned.

      Parameters

      • Rest ...args: unknown[]

        Any number of arguments to be logged.

        -

      Returns Logger

    • Logs at fatal level with filtering applied. For convenience this object is returned.

      +

    Returns Logger

    • Logs at fatal level with filtering applied. For convenience this object is returned.

      Parameters

      • Rest ...args: unknown[]

        Any number of arguments to be logged.

        -

      Returns Logger

    • get the bare (pino) logger instead of using the class hierarchy

      -

      Returns Logger

    • Logs at info level with filtering applied. For convenience this object is returned.

      +

    Returns Logger

    • get the bare (pino) logger instead of using the class hierarchy

      +

      Returns Logger

    • Logs at info level with filtering applied. For convenience this object is returned.

      Parameters

      • Rest ...args: unknown[]

        Any number of arguments to be logged.

        -

      Returns Logger

    • Reads a text blob of all the log lines contained in memory or the log file.

      -

      Returns string

    • Set the logging level of all streams for this logger. If a specific level is not provided, this method will +

    Returns Logger

    • Reads a text blob of all the log lines contained in memory or the log file.

      +

      Returns string

    • Set the logging level of all streams for this logger. If a specific level is not provided, this method will attempt to read it from the environment variable SFDX_LOG_LEVEL, and if not found, Logger.DEFAULT_LOG_LEVEL will be used instead. For convenience this object is returned.

      Parameters

      • Optional level: number

        The logger level.

        @@ -66,25 +66,25 @@ was invalid.

        // Sets the level from the environment or default value
        logger.setLevel()

        // Set the level from the INFO enum
        logger.setLevel(LoggerLevel.INFO)

        // Sets the level case-insensitively from a string value
        logger.setLevel(Logger.getLevelByName('info'))
        -

      Returns Logger

    • Compares the requested log level with the current log level. Returns true if +

    Returns Logger

    • Compares the requested log level with the current log level. Returns true if the requested log level is greater than or equal to the current log level.

      Parameters

      • level: number

        The requested log level to compare against the currently set log level.

        -

      Returns boolean

    • Logs at trace level with filtering applied. For convenience this object is returned.

      +

    Returns boolean

    • Logs at trace level with filtering applied. For convenience this object is returned.

      Parameters

      • Rest ...args: any[]

        Any number of arguments to be logged.

        -

      Returns Logger

    • Logs at warn level with filtering applied. For convenience this object is returned.

      +

    Returns Logger

    • Logs at warn level with filtering applied. For convenience this object is returned.

      Parameters

      • Rest ...args: unknown[]

        Any number of arguments to be logged.

        -

      Returns Logger

    • Create a child of the root logger, inheriting this instance's configuration such as level, transports, etc.

      +

    Returns Logger

    • Create a child of the root logger, inheriting this instance's configuration such as level, transports, etc.

      Parameters

      • name: string

        The name of the child logger.

      • Optional fields: Fields

        Additional fields included in all log lines.

        -

      Returns Promise<Logger>

    • Create a child of the root logger, inheriting this instance's configuration such as level, transports, etc.

      +

    Returns Promise<Logger>

    • Create a child of the root logger, inheriting this instance's configuration such as level, transports, etc.

      Parameters

      • name: string

        The name of the child logger.

      • Optional fields: Fields

        Additional fields included in all log lines.

        -

      Returns Logger

    • Gets a numeric LoggerLevel value by string name.

      +

    Returns Logger

    • Gets a numeric LoggerLevel value by string name.

      Parameters

      • levelName: string

        The level name to convert to a LoggerLevel enum value.

        Throws SfError{ name: 'UnrecognizedLoggerLevelNameError' } The level name was not case-insensitively recognized as a valid LoggerLevel value.

      Returns number

      See

      {@Link LoggerLevel}

      -
    • get the bare (pino) logger instead of using the class hierarchy

      -

      Returns Logger

    • get the bare (pino) logger instead of using the class hierarchy

      +

      Returns Logger

    \ No newline at end of file +

    Returns Promise<Logger>

    \ No newline at end of file diff --git a/classes/logger_memoryLogger.MemoryLogger.html b/classes/logger_memoryLogger.MemoryLogger.html index b9e7c5ba0..01784958a 100644 --- a/classes/logger_memoryLogger.MemoryLogger.html +++ b/classes/logger_memoryLogger.MemoryLogger.html @@ -1,5 +1,5 @@ MemoryLogger | @salesforce/core

    Used by test setup to keep UT from writing to disk.

    -

    Hierarchy

    • Writable
      • MemoryLogger

    Constructors

    Hierarchy

    • Writable
      • MemoryLogger

    Constructors

    Properties

    Methods

    Constructors

    Properties

    loggedData: Record<string, unknown>[] = []

    Methods

    • Parameters

      • chunk: Record<string, unknown>
      • encoding: string
      • callback: ((err?) => void)
          • (err?): void
          • Parameters

            • Optional err: Error

            Returns void

      Returns void

    \ No newline at end of file +

    Constructors

    Properties

    loggedData: Record<string, unknown>[] = []

    Methods

    • Parameters

      • chunk: Record<string, unknown>
      • encoding: string
      • callback: ((err?) => void)
          • (err?): void
          • Parameters

            • Optional err: Error

            Returns void

      Returns void

    \ No newline at end of file diff --git a/classes/messages.Messages.html b/classes/messages.Messages.html index 1b2f82060..08087b298 100644 --- a/classes/messages.Messages.html +++ b/classes/messages.Messages.html @@ -26,7 +26,7 @@ do it once) or load the message file the test depends on individually.

    // Create loader functions for all files in the messages directory
    Messages.importMessagesDirectory(__dirname);

    // or, for ESM code
    Messages.importMessagesDirectoryFromMetaUrl(import.meta.url)

    // Now you can use the messages from anywhere in your code or file.
    // If using importMessageDirectory, the bundle name is the file name.
    const messages: Messages = Messages.loadMessages(packageName, bundleName);

    // Messages now contains all the message in the bundleName file.
    messages.getMessage('authInfoCreationError');
    -

    Type Parameters

    Constructors

    Type Parameters

    • T extends string

    Constructors

    Properties

    bundleName locale messages @@ -48,10 +48,10 @@

    Type Parameters

    • T extends string

    Parameters

    • bundleName: string

      The bundle name.

    • locale: string

      The locale.

    • messages: StoredMessageMap

      The messages. Can not be modified once created.

      -

    Returns Messages<T>

    Properties

    bundleName: string

    The bundle name.

    -
    locale: string

    The locale of the messages in this bundle.

    -

    The messages. Can not be modified once created.

    -

    Methods

    • Convenience method to create errors using message labels.

      +

    Returns Messages<T>

    Properties

    bundleName: string

    The bundle name.

    +
    locale: string

    The locale of the messages in this bundle.

    +

    The messages. Can not be modified once created.

    +

    Methods

    • Convenience method to create errors using message labels.

      error.name will be the upper-cased key, remove prefixed error. and will always end in Error. error.actions will be loaded using ${key}.actions if available.

      Parameters

      • key: T

        The key of the error message.

        @@ -59,25 +59,25 @@
      • actionTokens: Tokens = []

        The action messages tokens.

      • Optional exitCodeOrCause: number | Error

        The exit code which will be used by SfdxCommand or the underlying error that caused this error to be raised.

      • Optional cause: Error

        The underlying error that caused this error to be raised.

        -

      Returns SfError<AnyJson>

    • Convenience method to create info using message labels.

      +

    Returns SfError<AnyJson>

    • Convenience method to create info using message labels.

      info.name will be the upper-cased key, remove prefixed info. and will always end in Info. info.actions will be loaded using ${key}.actions if available.

      Parameters

      • key: T

        The key of the warning message.

      • tokens: Tokens = []

        The warning message tokens.

      • actionTokens: Tokens = []

        The action messages tokens.

        -

      Returns StructuredMessage

    • Convenience method to create warning using message labels.

      +

    Returns StructuredMessage

    • Convenience method to create warning using message labels.

      warning.name will be the upper-cased key, remove prefixed warning. and will always end in Warning. warning.actions will be loaded using ${key}.actions if available.

      Parameters

      • key: T

        The key of the warning message.

      • tokens: Tokens = []

        The warning message tokens.

      • actionTokens: Tokens = []

        The action messages tokens.

        -

      Returns StructuredMessage

    • Get a message using a message key and use the tokens as values for tokenization.

      +

    Returns StructuredMessage

    • Get a message using a message key and use the tokens as values for tokenization.

      If the key happens to be an array of messages, it will combine with OS.EOL.

      Parameters

      Returns string

    • Get messages using a message key and use the tokens as values for tokenization.

      +

    Returns string

    • Get messages using a message key and use the tokens as values for tokenization.

      This will return all messages if the key is an array in the messages file.

      {
      "myKey": [ "message1", "message2" ]
      }
      @@ -87,18 +87,18 @@
    • tokens: Tokens = []

      The values to substitute in the message.

      See https://nodejs.org/api/util.html#util_util_format_format_args Note Unlike util.format(), specifiers are required for a token to be rendered.

      -

    Returns string[]

    Returns string[]

    • Get the locale. This will always return 'en_US' but will return the +

    Returns LoaderFunction<string>

    • Get the locale. This will always return 'en_US' but will return the machine's locale in the future.

      -

      Returns string

    • Add a single message file to the list of loading functions using the file name as the bundle name. +

      Returns string

    • Add a single message file to the list of loading functions using the file name as the bundle name. The loader will only be added if the bundle name is not already taken.

      Parameters

      • packageName: string

        The npm package name.

      • filePath: string

        The path of the file.

        -

      Returns void

    • Import all json and js files in a messages directory. Use the file name as the bundle key when +

    Returns void

    • Import all json and js files in a messages directory. Use the file name as the bundle key when Messages.loadMessages is called. By default, we're assuming the moduleDirectoryPart is a typescript project and will truncate to root path (where the package.json file is). If your messages directory is in another spot or you are not using typescript, pass in false for truncateToProjectPath.

      @@ -108,22 +108,22 @@
    • truncateToProjectPath: boolean = true

      Will look for the messages directory in the project root (where the package.json file is located). i.e., the module is typescript and the messages folder is in the top level of the module directory.

    • Optional packageName: string

      The npm package name. Figured out from the root directory's package.json.

      -

    Returns void

    • Support ESM plugins who can't use __dirname

      +

    Returns void

    • Support ESM plugins who can't use __dirname

      Parameters

      • metaUrl: string

        pass in import.meta.url

      • truncateToProjectPath: boolean = true

        Will look for the messages directory in the project root (where the package.json file is located). i.e., the module is typescript and the messages folder is in the top level of the module directory.

      • Optional packageName: string

        The npm package name. Figured out from the root directory's package.json.

        -

      Returns void

    • Check if a bundle already been loaded.

      +

    Returns void

    • Check if a bundle already been loaded.

      Parameters

      • packageName: string

        The npm package name.

      • bundleName: string

        The bundle name.

        -

      Returns boolean

    • Load messages for a given package and bundle. If the bundle is not already cached, use the loader function +

    Returns boolean

    • Load messages for a given package and bundle. If the bundle is not already cached, use the loader function created from Messages.setLoaderFunction or Messages.importMessagesDirectory.

      Messages.importMessagesDirectory(__dirname);
      const messages = Messages.loadMessages('packageName', 'bundleName');

      Parameters

      • packageName: string

        The name of the npm package.

      • bundleName: string

        The name of the bundle to load.

        -

      Returns Messages<string>

    • Set a custom loader function for a package and bundle that will be called on Messages.loadMessages.

      +

    Returns Messages<string>

    • Set a custom loader function for a package and bundle that will be called on Messages.loadMessages.

      Parameters

      • packageName: string

        The npm package name.

      • bundle: string

        The name of the bundle.

      • loader: LoaderFunction<string>

        The loader function.

        -

      Returns void

    \ No newline at end of file +

    Returns void

    \ No newline at end of file diff --git a/classes/org_authInfo.AuthInfo-1.html b/classes/org_authInfo.AuthInfo-1.html index 693017d28..6f38fa8f4 100644 --- a/classes/org_authInfo.AuthInfo-1.html +++ b/classes/org_authInfo.AuthInfo-1.html @@ -6,7 +6,7 @@

    See Salesforce DX Usernames and Orgs

    // Creating a new authentication file.
    const authInfo = await AuthInfo.create({
    username: myAdminUsername,
    oauth2Options: {
    loginUrl, authCode, clientId, clientSecret
    }
    );
    authInfo.save();

    // Creating an authorization info with an access token.
    const authInfo = await AuthInfo.create({
    username: accessToken
    });

    // Using an existing authentication file.
    const authInfo = await AuthInfo.create({
    username: myAdminUsername
    });

    // Using the AuthInfo
    const connection = await Connection.create({ authInfo });
    -

    Hierarchy

    Constructors

    Hierarchy

    Constructors

    Methods

    Constructors

    • Constructor Do not directly construct instances of this class -- use AuthInfo.create instead.

      Parameters

      Returns AuthInfo

    Methods

    • Get the authorization fields.

      +

    Returns AuthInfo

    Methods

    • Get the authorization fields.

      Parameters

      • Optional decrypt: boolean

        Decrypt the fields.

        Returns a ReadOnly object of the fields. If you need to modify the fields, use AuthInfo.update()

        -

      Returns Readonly<AuthFields>

    • Get the org front door (used for web based oauth flows)

      -

      Returns string

    • Get the SFDX Auth URL.

      +

    Returns Readonly<AuthFields>

    • Get the org front door (used for web based oauth flows)

      +

      Returns string

    • Convenience function to handle typical side effects encountered when dealing with an AuthInfo. +

      Returns string

    • Convenience function to handle typical side effects encountered when dealing with an AuthInfo. Given the values supplied in parameter sideEffects, this function will set auth alias, default auth and default dev hub.

      Parameters

      Returns Promise<void>

    • Initializes an instance of the AuthInfo class.

      -

      Returns Promise<void>

    • Returns true if this is using an access token flow.

      -

      Returns boolean

    • Returns true if this is using the refresh token flow.

      -

      Returns boolean

    • Returns true if this org is using access token auth.

      -

      Returns boolean

    • Updates the cache and persists the authentication fields (encrypted).

      +

    Returns Promise<void>

    • Initializes an instance of the AuthInfo class.

      +

      Returns Promise<void>

    • Returns true if this is using an access token flow.

      +

      Returns boolean

    • Returns true if this is using the refresh token flow.

      +

      Returns boolean

    • Returns true if this org is using access token auth.

      +

      Returns boolean

    • Sets the provided alias to the username

      +

    Returns Promise<AuthInfo>

    • Sets the provided alias to the username

      Parameters

      • alias: string

        alias to set

        -

      Returns Promise<void>

    • Set the target-env (default) or the target-dev-hub to the alias if +

    Returns Promise<void>

    • Set the target-env (default) or the target-dev-hub to the alias if it exists otherwise to the username. Method will try to set the local config first but will default to global config if that fails.

      -

      Parameters

      • options: {
            devHub?: boolean;
            org?: boolean;
        } = ...
        • Optional devHub?: boolean
        • Optional org?: boolean

      Returns Promise<void>

    • Update the authorization fields, encrypting sensitive fields, but do not persist. +

      Parameters

      • options: {
            devHub?: boolean;
            org?: boolean;
        } = ...
        • Optional devHub?: boolean
        • Optional org?: boolean

      Returns Promise<void>

    • Update the authorization fields, encrypting sensitive fields, but do not persist. For convenience this object is returned.

      Parameters

      • Optional authData: AuthFields

        Authorization fields to update.

        -

      Returns AuthInfo

    • Get the authorization URL.

      +

    Returns AuthInfo

    • Get the authorization URL.

      Parameters

      • options: OAuth2Config & {
            authCode?: string;
            privateKey?: string;
            privateKeyFile?: string;
            refreshToken?: string;
            username?: string;
        } & {
            scope?: string;
        }

        The options to generate the URL.

        -
      • Optional oauth2: OAuth2

      Returns string

    • Returns true if one or more authentications are persisted.

      -

      Returns Promise<boolean>

    • Given a set of decrypted fields and an authInfo, determine if the org belongs to an available +

    • Optional oauth2: OAuth2

    Returns string

    • Returns true if one or more authentications are persisted.

      +

      Returns Promise<boolean>

    • Given a set of decrypted fields and an authInfo, determine if the org belongs to an available dev hub, or if the org is a sandbox of another CLI authed production org.

      -

      Parameters

      Returns Promise<void>

    • Get a list of all authorizations based on auth files stored in the global directory. One can supply a filter (see

      Parameters

      • orgAuthFilter: ((orgAuth) => boolean) = ...

        A predicate function that returns true for those org authorizations that are to be retained.

        -

      Returns Promise<OrgAuthorization[]>

    • Parse a sfdx auth url, usually obtained by authInfo.getSfdxAuthUrl.

      +

    Returns Promise<OrgAuthorization[]>

    • Parse a sfdx auth url, usually obtained by authInfo.getSfdxAuthUrl.

      Parameters

      • sfdxAuthUrl: string

      Returns Pick<AuthFields, "clientId" | "loginUrl" | "clientSecret" | "refreshToken">

      Example

      await AuthInfo.create(AuthInfo.parseSfdxAuthUrl(sfdxAuthUrl));
       
      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/classes/org_authRemover.AuthRemover.html b/classes/org_authRemover.AuthRemover.html index f4dee9e5a..7fbf81db0 100644 --- a/classes/org_authRemover.AuthRemover.html +++ b/classes/org_authRemover.AuthRemover.html @@ -7,7 +7,7 @@
    const remover = await AuthRemover.create();
    const auth = await remover.findAuth(
    example@mycompany.com
    );
    await remover.removeAuth(auth.username);
    -

    Hierarchy

    Constructors

    Hierarchy

    • AsyncOptionalCreatable
      • AuthRemover

    Constructors

    Methods

    findAllAuths findAuth removeAllAuths @@ -16,11 +16,11 @@ New subclass instances must be created with the static create method.

    Parameters

    • Optional options: object

      An options object providing initialization params.

    Returns AuthRemover

    Methods

    • Finds authorization files for username/alias in the global .sfdx folder Throws SfError{ name: 'TargetOrgNotSetError' } if no target-org Throws SfError{ name: 'NamedOrgNotFoundError' } if specified user is not found

      Parameters

      • Optional usernameOrAlias: string

        username or alias of the auth you want to find, defaults to the configured target-org

        -

      Returns Promise<AuthFields>

    • Removes all authentication files and any configs or aliases associated with them

      -

      Returns Promise<void>

    • Removes the authentication and any configs or aliases associated with it

      +

    Returns Promise<AuthFields>

    • Removes all authentication files and any configs or aliases associated with them

      +

      Returns Promise<void>

    • Removes the authentication and any configs or aliases associated with it

      Parameters

      • usernameOrAlias: string

        the username or alias that you want to remove

        -

      Returns Promise<void>

    \ No newline at end of file +

    Returns Promise<void>

    \ No newline at end of file diff --git a/classes/org_connection.Connection-1.html b/classes/org_connection.Connection-1.html index b8a99704e..cdb057fcb 100644 --- a/classes/org_connection.Connection-1.html +++ b/classes/org_connection.Connection-1.html @@ -1,7 +1,7 @@ Connection | @salesforce/core

    Handles connections and requests to Salesforce Orgs.

    // Uses latest API version
    const connection = await Connection.create({
    authInfo: await AuthInfo.create({ username: 'myAdminUsername' })
    });
    connection.query('SELECT Name from Account');

    // Use different API version
    connection.setApiVersion("42.0");
    connection.query('SELECT Name from Account');
    -

    Type Parameters

    • S extends Schema = Schema

    Hierarchy

    • Connection<S>
      • Connection

    Accessors

    Type Parameters

    • S extends Schema = Schema

    Hierarchy

    • Connection<S>
      • Connection

    Accessors

    Methods

    Accessors

    Methods

    • Executes a query and auto-fetches (i.e., "queryMore") all results. This is especially +

      Returns Tooling<S>

    Methods

    • Executes a query and auto-fetches (i.e., "queryMore") all results. This is especially useful with large query result sizes, such as over 2000 records. The default maximum fetch size is 10,000 records. Modify this via the options argument.

      Type Parameters

      • T extends Schema = S

      Parameters

      • soql: string

        The SOQL string.

      • queryOptions: Partial<QueryOptions & {
            tooling: boolean;
        }> = ...

        The query options. NOTE: the autoFetch option will always be true.

        -

      Returns Promise<QueryResult<T>>

    • deploy a zipped buffer from the SDRL with REST or SOAP

      +

    Returns Promise<QueryResult<T>>

    • deploy a zipped buffer from the SDRL with REST or SOAP

      Parameters

      • zipInput: Buffer

        data to deploy

      • options: DeployOptionsWithRest

        JSForce deploy options + a boolean for rest

        -

      Returns Promise<DeployResultLocator<AsyncResult & Schema>>

    • Get the API version used for all connection requests.

      -

      Returns string

    • Getter for the username of the Salesforce Org.

      -

      Returns Optional<string>

    • Verify that instance has a reachable DNS entry, otherwise will throw error

      -

      Returns Promise<boolean>

    • Returns true if this connection is using access token auth.

      -

      Returns boolean

    • Normalize a Salesforce url to include a instance information.

      +

    Returns Promise<DeployResultLocator<AsyncResult & Schema>>

    • Get the API version used for all connection requests.

      +

      Returns string

    • Getter for the username of the Salesforce Org.

      +

      Returns Optional<string>

    • Verify that instance has a reachable DNS entry, otherwise will throw error

      +

      Returns Promise<boolean>

    • Returns true if this connection is using access token auth.

      +

      Returns boolean

    • Normalize a Salesforce url to include a instance information.

      Parameters

      • url: string

        Partial url.

        -

      Returns string

    • Executes a get request on the baseUrl to force an auth refresh +

    Returns string

    Returns StreamPromise<R>

    Returns void

    Returns Promise<T>

    \ No newline at end of file +

    Returns Promise<Connection<S>>

    \ No newline at end of file diff --git a/classes/org_org.Org-1.html b/classes/org_org.Org-1.html index c221ec3ab..5eaf925af 100644 --- a/classes/org_org.Org-1.html +++ b/classes/org_org.Org-1.html @@ -6,7 +6,7 @@
    // Email username
    const org1: Org = await Org.create({ aliasOrUsername: 'foo@example.com' });
    // The target-org config property
    const org2: Org = await Org.create();
    // Full Connection
    const org3: Org = await Org.create({
    connection: await Connection.create({
    authInfo: await AuthInfo.create({ username: 'username' })
    })
    });

    See https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_cli_usernames_orgs.htm

    -

    Hierarchy

    Methods

    Hierarchy

    Methods

    addUsername checkScratchOrg cleanLocalOrgData cloneSandbox @@ -50,101 +50,101 @@
    const org: Org = await Org.create({
    connection: await Connection.create({
    authInfo: await AuthInfo.create('foo@example.com')
    })
    });
    const userAuth: AuthInfo = await AuthInfo.create({
    username: 'bar@example.com'
    });
    await org.addUsername(userAuth);

    Parameters

    • auth: string | AuthInfo

      The AuthInfo for the username to add.

      -

    Returns Promise<Org>

    • Check that this org is a scratch org by asking the dev hub if it knows about it.

      +

    Returns Promise<Org>

    • Check that this org is a scratch org by asking the dev hub if it knows about it.

      Throws SfError{ name: 'NotADevHubError' } Not a Dev Hub.

      Throws SfError{ name: 'NoResultsError' } No results.

      Parameters

      • Optional devHubUsernameOrAlias: string

        The username or alias of the dev hub org.

        -

      Returns Promise<Partial<AuthFields>>

    • Clean all data files in the org's data path. Usually /.sfdx/orgs/.

      +

    Returns Promise<Partial<AuthFields>>

    • Clean all data files in the org's data path. Usually /.sfdx/orgs/.

      Parameters

      • Optional orgDataPath: string

        A relative path other than "orgs/".

      • throwWhenRemoveFails: boolean = false

        Should the remove org operations throw an error on failure?

        -

      Returns Promise<void>

    • Parameters

      • sandboxReq: SandboxRequest

        SandboxRequest options to create the sandbox with

      • sourceSandboxName: string

        the name of the sandbox that your new sandbox will be based on

      • options: {
            interval?: Duration;
            wait?: Duration;
        }

        Wait: The amount of time to wait before timing out, defaults to 0, Interval: The time interval between polling defaults to 30 seconds

        • Optional interval?: Duration
        • Optional wait?: Duration

      Returns Promise<SandboxProcessObject>

      the newly created sandbox process object

      -
    • create a sandbox from a production org 'this' needs to be a production org with sandbox licenses available

      Parameters

      • sandboxReq: SandboxRequest

        SandboxRequest options to create the sandbox with

      • options: {
            async?: boolean;
            interval?: Duration;
            wait?: Duration;
        } = ...

        Wait: The amount of time to wait before timing out, Interval: The time interval between polling

        -
        • Optional async?: boolean
        • Optional interval?: Duration
        • Optional wait?: Duration

      Returns Promise<SandboxProcessObject>

    • Will delete 'this' instance remotely and any files locally

      -

      Returns Promise<void>

    • Will delete 'this' instance remotely and any files locally

      +
      • Optional async?: boolean
      • Optional interval?: Duration
      • Optional wait?: Duration

    Returns Promise<SandboxProcessObject>

    • Will delete 'this' instance remotely and any files locally

      +

      Returns Promise<void>

    • Will delete 'this' instance remotely and any files locally

      Parameters

      • controllingOrg: string | Org

        username or Org that 'this.devhub' or 'this.production' refers to. AKA a DevHub for a scratch org, or a Production Org for a sandbox

        -

      Returns Promise<void>

    • Returns true if the org is a Dev Hub.

      +

    Returns Promise<void>

    • Returns true if the org is a Dev Hub.

      Use a cached value. If the cached value is not set, then check access to the ScratchOrgInfo object to determine if the org is a dev hub.

      Parameters

      • forceServerCheck: boolean = false

        Ignore the cached value and go straight to the server which will be required if the org flips on the dev hub after the value is already cached locally.

        -

      Returns Promise<boolean>

    • Returns true if the org is a sandbox.

      +

    Returns Promise<boolean>

    • Returns true if the org is a sandbox.

      Use a cached value. If the cached value is not set, then check Organization.IsSandbox == true && Organization.TrialExpirationDate == null using Org.retrieveOrganizationInformation.

      -

      Returns Promise<boolean>

    • Returns true if the org is a scratch org.

      +

      Returns Promise<boolean>

    • Returns true if the org is a scratch org.

      Use a cached value. If the cached value is not set, then check Organization.IsSandbox == true && Organization.TrialExpirationDate != null using Org.retrieveOrganizationInformation.

      -

      Returns Promise<boolean>

    • Returns the JSForce connection for the org. +

      Returns Promise<boolean>

    • Returns the JSForce connection for the org. side effect: If you pass it an apiVersion, it will set it on the Org so that future calls to getConnection() will also use that version.

      Parameters

      • Optional apiVersion: string

        The API version to use for the connection.

        -

      Returns Connection<Schema>

    • Returns the Org object or null if this org is not affiliated with a Dev Hub (according to the local config).

      -

      Returns Promise<undefined | Org>

    • Returns an org field. Returns undefined if the field is not set or invalid.

      -

      Type Parameters

      • T = AnyJson

      Parameters

      Returns T

    • Returns the orgId for this org.

      -

      Returns string

    • get the sandbox config for the given orgId

      +

    Returns Connection<Schema>

    • Returns the Org object or null if this org is not affiliated with a Dev Hub (according to the local config).

      +

      Returns Promise<undefined | Org>

    • Returns an org field. Returns undefined if the field is not set or invalid.

      +

      Type Parameters

      • T = AnyJson

      Parameters

      Returns T

    • Returns the orgId for this org.

      +

      Returns string

    • get the sandbox config for the given orgId

      Parameters

      • orgId: string

        {string} orgId of the sandbox

        -

      Returns Promise<Nullable<SandboxFields>>

    • Returns the admin username used to create the org.

      -

      Returns undefined | string

    • Returns true if the org is a Dev Hub.

      +

    Returns Promise<Nullable<SandboxFields>>

    • Returns the admin username used to create the org.

      +

      Returns undefined | string

    • Returns true if the org is a Dev Hub.

      Note This relies on a cached value in the auth file. If that property is not cached, this method will always return false even if the org is a dev hub. If you need accuracy, use the Org.determineIfDevHubOrg method.

      -

      Returns boolean

    • Check if org is a sandbox org by checking its SandboxOrgConfig.

      -

      Returns Promise<boolean>

    • Returns true if the org is a scratch org.

      +

      Returns boolean

    • Check if org is a sandbox org by checking its SandboxOrgConfig.

      +

      Returns Promise<boolean>

    • Returns true if the org is a scratch org.

      Note This relies on a cached value in the auth file. If that property is not cached, this method will always return false even if the org is a scratch org. If you need accuracy, use the Org.determineIfScratch method.

      -

      Returns boolean

    • query SandboxProcess via SandboxOrganization (sandbox Org ID)

      +

    Returns Promise<SandboxProcessObject>

    • query SandboxProcess via SandboxInfoId

      +

    Returns Promise<SandboxProcessObject>

    • query SandboxProcess via sandbox name

      +

    Returns Promise<SandboxProcessObject>

    • Reads and returns the content of all user auth files for this org as an array.

      -

      Returns Promise<AuthInfo[]>

    • Refreshes the auth for this org's instance by calling HTTP GET on the baseUrl of the connection object.

      -

      Returns Promise<void>

    • Refresh (update) a sandbox from a production org. +

    Returns Promise<SandboxProcessObject>

    • Reads and returns the content of all user auth files for this org as an array.

      +

      Returns Promise<AuthInfo[]>

    • Refreshes the auth for this org's instance by calling HTTP GET on the baseUrl of the connection object.

      +

      Returns Promise<void>

    • Refresh (update) a sandbox from a production org. 'this' needs to be a production org with sandbox licenses available

      Parameters

      • sandboxInfo: SandboxInfo

        SandboxInfo to update the sandbox with

      • options: {
            async?: boolean;
            interval?: Duration;
            wait?: Duration;
        } = ...

        Wait: The amount of time to wait before timing out, Interval: The time interval between polling

        -
        • Optional async?: boolean
        • Optional interval?: Duration
        • Optional wait?: Duration

      Returns Promise<SandboxProcessObject>

    • Cleans up all org related artifacts including users, sandbox config (if a sandbox), source tracking files, and auth file.

      +
      • Optional async?: boolean
      • Optional interval?: Duration
      • Optional wait?: Duration

    Returns Promise<SandboxProcessObject>

    • Cleans up all org related artifacts including users, sandbox config (if a sandbox), source tracking files, and auth file.

      Parameters

      • throwWhenRemoveFails: boolean = false

        Determines if the call should throw an error or fail silently.

        -

      Returns Promise<void>

    • Removes a username from the user config for this object. For convenience this object is returned.

      +

    Returns Promise<void>

    • Removes a username from the user config for this object. For convenience this object is returned.

      Throws SfError{ name: 'MissingAuthInfoError' } Auth info is missing.

      Parameters

      • auth: string | AuthInfo

        The AuthInfo containing the username to remove.

        -

      Returns Promise<Org>

    • Resume a sandbox create or refresh from a production org. +

    Returns Promise<Org>

    • Resume a sandbox create or refresh from a production org. this needs to be a production org with sandbox licenses available.

      Parameters

      • resumeSandboxRequest: ResumeSandboxRequest

        SandboxRequest options to create/refresh the sandbox with

      • options: {
            async?: boolean;
            interval?: Duration;
            wait?: Duration;
        } = ...

        Wait: The amount of time to wait (default: 0 minutes) before timing out, Interval: The time interval (default: 30 seconds) between polling

        -
        • Optional async?: boolean
        • Optional interval?: Duration
        • Optional wait?: Duration

      Returns Promise<SandboxProcessObject>

    • Retrieves the highest api version that is supported by the target server instance. If the apiVersion configured for +

      • Optional async?: boolean
      • Optional interval?: Duration
      • Optional wait?: Duration

    Returns Promise<SandboxProcessObject>

    • Retrieves the highest api version that is supported by the target server instance. If the apiVersion configured for Sfdx is greater than the one returned in this call an api version mismatch occurs. In the case of the CLI that results in a warning.

      -

      Returns Promise<string>

    • Retrieve a handful of fields from the Organization table in Salesforce. If this does not have the +

      Returns Promise<string>

    • Reports sandbox org creation status. If the org is ready, authenticates to the org.

      Parameters

      • sandboxname: string
      • options: {
            interval?: Duration;
            wait?: Duration;
        }

        Wait: The amount of time to wait before timing out, Interval: The time interval between polling

        • Optional interval?: Duration
        • Optional wait?: Duration

      Returns Promise<SandboxProcessObject>

      the sandbox process object

      -
    • set the sandbox config related to this given org

      Parameters

      • orgId: string

        {string} orgId of the sandbox

      • config: SandboxFields

        {SandboxFields} config of the sandbox

        -

      Returns Promise<Org>

    • Set the tracking property on the org's auth file

      +

    Returns Promise<Org>

    • Set the tracking property on the org's auth file

      Parameters

      • value: boolean

        true or false (whether the org should use source tracking or not)

        -

      Returns Promise<void>

    • Returns Promise<boolean>

    • Returns true if the org uses source tracking. +

    Returns Promise<void>

    • Returns Promise<boolean>

    • Returns true if the org uses source tracking. Side effect: updates files where the property doesn't currently exist

      -

      Returns Promise<boolean>

    \ No newline at end of file +

    Returns Promise<undefined | Pick<AuthFields, NAME | NAMESPACE_PREFIX | INSTANCE_NAME | TRIAL_EXPIRATION_DATE | IS_SCRATCH | IS_SANDBOX>>

    \ No newline at end of file diff --git a/classes/org_permissionSetAssignment.PermissionSetAssignment.html b/classes/org_permissionSetAssignment.PermissionSetAssignment.html index 852c6ba37..b936175c3 100644 --- a/classes/org_permissionSetAssignment.PermissionSetAssignment.html +++ b/classes/org_permissionSetAssignment.PermissionSetAssignment.html @@ -1,9 +1,9 @@ PermissionSetAssignment | @salesforce/core

    A class for assigning a Salesforce User to one or more permission sets.

    -

    Methods

    Methods

    Methods

    Returns Promise<PermissionSetAssignmentFields>

    \ No newline at end of file +

    Returns Promise<PermissionSetAssignment>

    \ No newline at end of file diff --git a/classes/org_scratchOrgCache.ScratchOrgCache.html b/classes/org_scratchOrgCache.ScratchOrgCache.html index a87e8cb4f..a1488f74f 100644 --- a/classes/org_scratchOrgCache.ScratchOrgCache.html +++ b/classes/org_scratchOrgCache.ScratchOrgCache.html @@ -1,7 +1,7 @@ ScratchOrgCache | @salesforce/core

    A Time To Live configuration file where each entry is timestamped and removed once the TTL has expired.

    Example

    import { Duration } from '@salesforce/kit';
    const config = await TTLConfig.create({
    isGlobal: false,
    ttl: Duration.days(1)
    });
    -

    Hierarchy (view full)

    Methods

    Hierarchy (view full)

    Methods

    access accessSync clear entries @@ -42,82 +42,82 @@ by perm.

    Parameters

    Returns Promise<boolean>

    • Determines if the config file is read/write accessible. Returns true if the user has capabilities specified +

    Returns Promise<boolean>

    • Check to see if the config file exists. Returns true if the config file exists and has access, false otherwise.

      -

      Returns Promise<boolean>

    • Invokes actionFn once for each key-value pair present in the config object.

      +

    Returns boolean

    • Check to see if the config file exists. Returns true if the config file exists and has access, false otherwise.

      +

      Returns Promise<boolean>

    • Invokes actionFn once for each key-value pair present in the config object.

      Parameters

      • actionFn: ((key, value) => void)

        The function (key: string, value: ConfigValue) => void to be called for each element.

        -
          • (key, value): void
          • Parameters

            • key: string
            • value: AnyJson

            Returns void

      Returns void

    • Returns the value associated to the key, or undefined if there is none.

      +
        • (key, value): void
        • Parameters

          • key: string
          • value: AnyJson

          Returns void

    Returns void

    Returns Entry<CachedOptions>

  • Type Parameters

    • V = AnyJson

    Parameters

    • key: string
    • Optional decrypt: boolean

    Returns V

  • Returns string[]

    Returns Promise<Contents<CachedOptions>>

    Returns Contents<CachedOptions>

    Returns void

    Returns void

    Returns boolean

    Returns boolean

    Returns void

    Returns Promise<string>

    \ No newline at end of file +

    Returns string

    \ No newline at end of file diff --git a/classes/org_scratchOrgFeatureDeprecation.ScratchOrgFeatureDeprecation.html b/classes/org_scratchOrgFeatureDeprecation.ScratchOrgFeatureDeprecation.html index 6934b76e4..2daae8040 100644 --- a/classes/org_scratchOrgFeatureDeprecation.ScratchOrgFeatureDeprecation.html +++ b/classes/org_scratchOrgFeatureDeprecation.ScratchOrgFeatureDeprecation.html @@ -1,10 +1,10 @@ -ScratchOrgFeatureDeprecation | @salesforce/core

    Constructors

    constructor +ScratchOrgFeatureDeprecation | @salesforce/core

    Constructors

    Methods

    • Removes all deprecated features for the organization.

      +

    Constructors

    Methods

    • Removes all deprecated features for the organization.

      Parameters

      • features: string[]

        List of features to filter

      Returns string[]

      feature array with proper mapping.

      -
    • Gets list of feature warnings that should be logged

      Parameters

      • features: string | string[]

        The requested features.

      Returns string[]

      List of string feature warnings.

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/classes/org_scratchOrgSettingsGenerator.default.html b/classes/org_scratchOrgSettingsGenerator.default.html index 8db16829f..8bb4890aa 100644 --- a/classes/org_scratchOrgSettingsGenerator.default.html +++ b/classes/org_scratchOrgSettingsGenerator.default.html @@ -1,6 +1,6 @@ default | @salesforce/core

    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.

    -

    Constructors

    Constructors

    • Parameters

      • Optional options: {
            asDirectory?: boolean;
            capitalizeRecordTypes?: boolean;
            mdApiTmpDir?: string;
            shapeDirName?: string;
        }
        • Optional asDirectory?: boolean
        • Optional capitalizeRecordTypes?: boolean
        • Optional mdApiTmpDir?: string
        • Optional shapeDirName?: string

      Returns default

    Methods

    • Create temporary deploy directory used to upload the scratch org shape. +

    Constructors

    • Parameters

      • Optional options: {
            asDirectory?: boolean;
            capitalizeRecordTypes?: boolean;
            mdApiTmpDir?: string;
            shapeDirName?: string;
        }
        • Optional asDirectory?: boolean
        • Optional capitalizeRecordTypes?: boolean
        • Optional mdApiTmpDir?: string
        • Optional shapeDirName?: string

      Returns default

    Methods

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

    • Deploys the settings to the org.

      -

      Parameters

      • scratchOrg: Org
      • apiVersion: string
      • timeout: Duration = ...

      Returns Promise<void>

    • extract the settings from the scratch def file, if they are present.

      -

      Parameters

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

    \ No newline at end of file +

    Returns Promise<void>

    \ No newline at end of file diff --git a/classes/org_user.DefaultUserFields-1.html b/classes/org_user.DefaultUserFields-1.html index 5502d727e..6a207fd28 100644 --- a/classes/org_user.DefaultUserFields-1.html +++ b/classes/org_user.DefaultUserFields-1.html @@ -2,6 +2,6 @@ software development purposes.

    const connection: Connection = await Connection.create({
    authInfo: await AuthInfo.create({ username: 'user@example.com' })
    });
    const org: Org = await Org.create({ connection });
    const options: DefaultUserFields.Options = {
    templateUser: org.getUsername()
    };
    const fields = (await DefaultUserFields.create(options)).getFields();
    -

    Hierarchy

    Methods

    Hierarchy

    Methods

    Methods

    \ No newline at end of file +

    Returns UserFields

    \ No newline at end of file diff --git a/classes/org_user.User-1.html b/classes/org_user.User-1.html index 759ff25c3..322ddb57c 100644 --- a/classes/org_user.User-1.html +++ b/classes/org_user.User-1.html @@ -1,6 +1,6 @@ User | @salesforce/core

    A class for creating a User, generating a password for a user, and assigning a user to one or more permission sets. See methods for examples.

    -

    Hierarchy

    Methods

    Hierarchy

    Methods

    assignPassword assignPermissionSets createUser init @@ -10,12 +10,12 @@ following org feature: EnableSetPasswordInApi.

    Parameters

    • info: AuthInfo

      The AuthInfo object for user to assign the password to.

    • password: SecureBuffer<void> = ...

      [throwWhenRemoveFails = User.generatePasswordUtf8()] A SecureBuffer containing the new password.

      -

    Returns Promise<void>

    • Methods to assign one or more permission set names to a user.

      +

    Returns Promise<void>

    • Methods to assign one or more permission set names to a user.

      Parameters

      • id: string

        The Salesforce id of the user to assign the permission set to.

      • permsetNames: string[]

        An array of permission set names.

        const username = 'user@example.com';
        const connection: Connection = await Connection.create({
        authInfo: await AuthInfo.create({ username })
        });
        const org = await Org.create({ connection });
        const user: User = await User.create({ org });
        const fields: UserFields = await user.retrieve(username);
        await user.assignPermissionSets(fields.id, ['sfdx', 'approver']);
        -

      Returns Promise<void>

    • Method for creating a new User.

      +

    Returns Promise<void>

    • Method for creating a new User.

      By default scratch orgs only allow creating 2 additional users. Work with Salesforce Customer Service to increase user limits.

      The Org Preferences required to increase the number of users are: @@ -24,10 +24,10 @@

      Parameters

      • fields: UserFields

        The required fields for creating a user.

        const connection: Connection = await Connection.create({
        authInfo: await AuthInfo.create({ username: 'user@example.com' })
        });
        const org = await Org.create({ connection });

        const defaultUserFields = await DefaultUserFields.create({ templateUser: 'devhub_user@example.com' });
        const user: User = await User.create({ org });
        const info: AuthInfo = await user.createUser(defaultUserFields.getFields());
        -

      Returns Promise<AuthInfo>

    • Initialize a new instance of a user and return it.

      -

      Returns Promise<void>

    • Method to retrieve the UserFields for a user.

      +

    Returns Promise<AuthInfo>

    • Initialize a new instance of a user and return it.

      +

      Returns Promise<void>

    • Method to retrieve the UserFields for a user.

      Parameters

      • username: string

        The username of the user.

        const username = 'boris@thecat.com';
        const connection: Connection = await Connection.create({
        authInfo: await AuthInfo.create({ username })
        });
        const org = await Org.create({ connection });
        const user: User = await User.create({ org });
        const fields: UserFields = await user.retrieve(username);
        -

      Returns Promise<UserFields>

    \ No newline at end of file +

    Returns Promise<UserFields>

    \ No newline at end of file diff --git a/classes/schema_validator.SchemaValidator.html b/classes/schema_validator.SchemaValidator.html index 11b3f5396..d69c430ff 100644 --- a/classes/schema_validator.SchemaValidator.html +++ b/classes/schema_validator.SchemaValidator.html @@ -1,5 +1,5 @@ SchemaValidator | @salesforce/core

    Loads a JSON schema and performs validations against JSON objects.

    -

    Constructors

    Constructors

    Methods

    load loadSync validate @@ -7,18 +7,18 @@

    Constructors

    • Creates a new SchemaValidator instance given a logger and path to a schema file.

      Parameters

      • logger: Logger

        An Logger instance on which to base this class's logger.

      • schemaPath: string

        The path to the schema file to load and use for validation.

        -

      Returns SchemaValidator

    Methods

    • Loads a JSON schema from the schemaPath parameter provided at instantiation.

      -

      Returns Promise<JsonMap>

    • Loads a JSON schema from the schemaPath parameter provided at instantiation.

      -

      Returns JsonMap

    • Performs validation of JSON data against the schema located at the schemaPath value provided +

    Returns SchemaValidator

    Methods

    • Loads a JSON schema from the schemaPath parameter provided at instantiation.

      +

      Returns Promise<JsonMap>

    • Loads a JSON schema from the schemaPath parameter provided at instantiation.

      +

      Returns JsonMap

    • Performs validation of JSON data against the schema located at the schemaPath value provided at instantiation.

      Throws SfError{ name: 'ValidationSchemaFieldError' } If there are known validations errors. Throws SfError{ name: 'ValidationSchemaUnknownError' } If there are unknown validations errors.

      Parameters

      • json: AnyJson

        A JSON value to validate against this instance's target schema.

      Returns Promise<AnyJson>

      The validated JSON data.

      -
    • Performs validation of JSON data against the schema located at the schemaPath value provided +

    • Performs validation of JSON data against the schema located at the schemaPath value provided at instantiation.

      Throws SfError{ name: 'ValidationSchemaFieldError' } If there are known validations errors. Throws SfError{ name: 'ValidationSchemaUnknownError' } If there are unknown validations errors.

      Type Parameters

      • T extends AnyJson

      Parameters

      • json: T

        A JSON value to validate against this instance's target schema.

      Returns T

      The validated JSON data.

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/classes/sfError.SfError.html b/classes/sfError.SfError.html index 358634351..bd79769d6 100644 --- a/classes/sfError.SfError.html +++ b/classes/sfError.SfError.html @@ -4,7 +4,7 @@ directly to the constructor, e.g.

    // To load a message bundle (Note that __dirname should contain a messages folder)
    Messages.importMessagesDirectory(__dirname);
    const messages = Messages.load('myPackageName', 'myBundleName');

    // To throw a non-bundle based error:
    throw new SfError(message.getMessage('myError'), 'MyErrorName');
    -

    Type Parameters

    Hierarchy

    Constructors

    Type Parameters

    • T extends ErrorDataProperties = ErrorDataProperties

    Hierarchy

    • Error
      • SfError

    Constructors

    Properties

    actions? context? data? @@ -22,15 +22,15 @@
  • Optional actions: string[]

    The action message(s).

  • Optional exitCodeOrCause: number | Error

    The exit code which will be used by SfdxCommand or he underlying error that caused this error to be raised.

  • Optional cause: unknown

    The underlying error that caused this error to be raised.

    -
  • Returns SfError<T>

    Properties

    actions?: string[]

    Action messages. Hints to the users regarding what can be done to fix related issues.

    -
    context?: string

    The related context for this error.

    -
    data?: T
    exitCode: number

    SfdxCommand can return this process exit code.

    -
    name: string

    Accessors

    Methods

    • Sets the context of the error. For convenience this object is returned.

      +

    Returns SfError<T>

    Properties

    actions?: string[]

    Action messages. Hints to the users regarding what can be done to fix related issues.

    +
    context?: string

    The related context for this error.

    +
    data?: T
    exitCode: number

    SfdxCommand can return this process exit code.

    +
    name: string

    Accessors

    Methods

    • Sets the context of the error. For convenience this object is returned.

      Parameters

      • context: string

        The command name.

        -

      Returns SfError<AnyJson>

    • An additional payload for the error. For convenience this object is returned.

      +

    Returns SfError<AnyJson>

    • An additional payload for the error. For convenience this object is returned.

      Parameters

      • data: T

        The payload data.

        -

      Returns SfError<AnyJson>

    • Convert an SfError state to an object. Returns a plain object representing the state of this error.

      -

      Returns SfErrorToObjectResult

    • like the constructor, but takes an typed object and let you also set context and data properties

      -

      Type Parameters

      • T extends AnyJson = AnyJson

      Parameters

      Returns SfError<T>

    • Convert an Error to an SfError.

      +

    Returns SfError<AnyJson>

    • Convert an SfError state to an object. Returns a plain object representing the state of this error.

      +

      Returns SfErrorToObjectResult

    • like the constructor, but takes an typed object and let you also set context and data properties

      +

      Type Parameters

      • T extends AnyJson = AnyJson

      Parameters

      Returns SfError<T>

    • Convert an Error to an SfError.

      Type Parameters

      • T extends AnyJson = AnyJson

      Parameters

      • err: unknown

        The error to convert.

        -

      Returns SfError<T>

    \ No newline at end of file +

    Returns SfError<T>

    \ No newline at end of file diff --git a/classes/sfProject.SfProject.html b/classes/sfProject.SfProject.html index ba0eb5ce6..ae618a77e 100644 --- a/classes/sfProject.SfProject.html +++ b/classes/sfProject.SfProject.html @@ -2,7 +2,7 @@ a hidden .sfdx folder that contains all the other local project config files.

    const project = await SfProject.resolve();
    const projectJson = await project.resolveProjectConfig();
    console.log(projectJson.sfdcLoginUrl);
    -

    Methods

    Methods

    • Get the currently activated package on the project. This has no implication on sfdx-project.json +

      Parameters

      • predicate: ((packageDir) => boolean)

      Returns Optional<NamedPackageDir>

    • Get the currently activated package on the project. This has no implication on sfdx-project.json but is useful for keeping track of package and source specific options in a process.

      -

      Returns Nullable<NamedPackageDir>

    • Parameters

      • id: string

      Returns string[]

    • Parameters

      • id: string

      Returns string[]

    • Get the project's default package directory defined in sfdx-project.json using first 'default: true' found. The first entry is returned if no default is specified.

      -

      Returns NamedPackageDir

    • Returns a read-only list of packageDirectories within sfdx-project.json, first reading +

    Returns Optional<NamedPackageDir>

    • Returns a read-only list of packageDirectories within sfdx-project.json, first reading and validating the file if necessary. i.e. modifying this array will not affect the sfdx-project.json file.

      -

      Returns Nullable<Dictionary<string>>

    • Returns a read-only list of packageDirectories within sfdx-project.json, first reading +

      Returns Nullable<Dictionary<string>>

    • Returns a read-only list of packageDirectories within sfdx-project.json, first reading and validating the file if necessary. i.e. modifying this array will not affect the sfdx-project.json file.

      -

      Returns NamedPackageDir[]

    • Returns the package from a file path.

      Parameters

      • path: string

        A file path. E.g. /Users/jsmith/projects/ebikes-lwc/force-app/apex/my-cls.cls

        -

      Returns Optional<NamedPackageDir>

    • Parameters

      • alias: string

      Returns Optional<string>

    • Returns the package name, E.g. 'force-app', from a file path.

      +

    Returns Optional<NamedPackageDir>

    • Parameters

      • alias: string

      Returns Optional<string>

    • Returns the package name, E.g. 'force-app', from a file path.

      Parameters

      • path: string

        A file path. E.g. /Users/jsmith/projects/ebikes-lwc/force-app/apex/my-cls.cls

        -

      Returns Optional<string>

    • Returns the absolute path of the package directory ending with the path separator. +

    Returns Optional<string>

    • Returns the absolute path of the package directory ending with the path separator. E.g., /Users/jsmith/projects/ebikes-lwc/force-app/

      Parameters

      • packageName: string

        Name of the package directory. E.g., 'force-app'

        -

      Returns Optional<string>

    • retrieve the configuration for a named plugin from sfdx-project.json.plugins.pluginName

      +

    Returns Optional<string>

    • retrieve the configuration for a named plugin from sfdx-project.json.plugins.pluginName

      Type Parameters

      • T extends Record<string, unknown>

      Parameters

      • pluginName: string

      Returns Promise<Readonly<T>>

      Example

      const project = await SfProject.resolve();
      const pluginConfig = await project.getPluginConfiguration('myPlugin');

      optionally pass a type parameter for your plugin configuration's schema

      -
    • Get the sfdx-project.json config. The global sfdx-project.json is used for user defaults that are not checked in to the project specific file.

      Note: When reading values from SfProjectJson, it is recommended to use SfProject.resolveProjectConfig instead.

      This is the sync method of SfProject.resolveSfProjectJson

      Parameters

      • isGlobal: boolean = false

        True to get the global project file, otherwise the local project config.

        -

      Returns SfProjectJson

    • Returns a read-only list of packageDirectories within sfdx-project.json, first reading +

    Returns SfProjectJson

    • Returns a read-only list of packageDirectories within sfdx-project.json, first reading and validating the file if necessary. i.e. modifying this array will not affect the sfdx-project.json file.

      There can be multiple packages in packageDirectories that point to the same directory. This method only returns one packageDirectory entry per unique directory path. This is useful when doing source operations based on directories but probably not as useful for packaging operations that want to do something for each package entry.

      -

      Returns NamedPackageDir[]

    • Has multiple package directories (MPD) defined in the project.

      -

      Returns boolean

    • Has package directories defined in the project.

      -

      Returns boolean

    • Has multiple package directories (MPD) defined in the project.

      +

      Returns boolean

    • Has package directories defined in the project.

      +

      Returns boolean

    • The project config is resolved from local and global SfProjectJson, ConfigAggregator, and a set of defaults. It is recommended to use this when reading values from SfProjectJson.

      The global SfProjectJson is used to allow the user to provide default values they may not want checked into their project's source.

      Returns Promise<JsonMap>

      A resolved config object that contains a bunch of different properties, including some 3rd party custom properties.

      -
    • Get the sfdx-project.json config. The global sfdx-project.json is used for user defaults +

    • Get the sfdx-project.json config. The global sfdx-project.json is used for user defaults that are not checked in to the project specific file.

      Note: When reading values from SfProjectJson, it is recommended to use SfProject.resolveProjectConfig instead.

      Parameters

      • isGlobal: boolean = false

        True to get the global project file, otherwise the local project config.

        -

      Returns Promise<SfProjectJson>

    • Set the currently activated package on the project. This has no implication on sfdx-project.json +

    Returns Promise<SfProjectJson>

    • Set the currently activated package on the project. This has no implication on sfdx-project.json but is useful for keeping track of package and source specific options in a process.

      Parameters

      • packageName: Nullable<string>

        The package name to activate. E.g. 'force-app'

        -

      Returns void

    • set the configuration for a named plugin from sfdx-project.json.plugins.pluginName, overwriting existing configuration

      +

    Returns void

    • set the configuration for a named plugin from sfdx-project.json.plugins.pluginName, overwriting existing configuration

      Type Parameters

      • T extends Record<string, unknown>

      Parameters

      • pluginName: string
      • config: T

      Returns Promise<void>

      Example

      const project = await SfProject.resolve();
      const pluginConfig = await project.setPluginConfiguration('myPlugin', {foo: 'bar', myLimit: 25});

      optionally pass a type parameter for your plugin configuration's schema

      -
    • Clear the cache to force reading from disk.

      NOTE: Only call this method if you must and you know what you are doing.

      -

      Returns void

    • Get a Project from a given path or from the working directory.

      Parameters

      • Optional path: string

        The path of the project.

        Throws SfError{ name: 'InvalidProjectWorkspaceError' } If the current folder is not located in a workspace.

        -

      Returns SfProject

    • Get a Project from a given path or from the working directory.

      +

    Returns SfProject

    • Get a Project from a given path or from the working directory.

      Parameters

      • Optional path: string

        The path of the project.

        Throws SfError{ name: 'InvalidProjectWorkspaceError' } If the current folder is not located in a workspace.

        -

      Returns Promise<SfProject>

    • Performs an upward directory search for an sfdx project file. Returns the absolute path to the project.

      +

    Returns Promise<SfProject>

    • Performs an upward directory search for an sfdx project file. Returns the absolute path to the project.

      Parameters

      • Optional dir: string

        The directory path to start traversing from.

        Throws SfError{ name: 'InvalidProjectWorkspaceError' } If the current folder is not located in a workspace.

        See traverseForFile

        See process.cwd()

        -

      Returns Promise<string>

    • Performs a synchronous upward directory search for an sfdx project file. Returns the absolute path to the project.

      +

    Returns Promise<string>

    • Performs a synchronous upward directory search for an sfdx project file. Returns the absolute path to the project.

      Parameters

      • Optional dir: string

        The directory path to start traversing from.

        Throws SfError{ name: 'InvalidProjectWorkspaceError' } If the current folder is not located in a workspace.

        See traverseForFileSync

        See process.cwd()

        -

      Returns string

    \ No newline at end of file +

    Returns string

    \ No newline at end of file diff --git a/classes/sfProject.SfProjectJson.html b/classes/sfProject.SfProjectJson.html index b06210ffc..0fc8ca889 100644 --- a/classes/sfProject.SfProjectJson.html +++ b/classes/sfProject.SfProjectJson.html @@ -11,7 +11,7 @@

    Example: reading a standard property

    const
     
    @example writing
    const project = await SfProject.resolve();
    const projectJson = await project.resolveProjectConfig();
    projectJson.set('namespace', 'new');
    await projectJson.write();

    See force:project:create

    -

    Hierarchy (view full)

    Properties

    Hierarchy (view full)

    Properties

    Methods

    access accessSync addPackageAlias @@ -60,115 +60,115 @@

    Example: reading a standard property

    const
     resolveRootFolder
     resolveRootFolderSync
     

    Properties

    BLOCKLIST: string[] = ...

    json properties that are uppercase, or allow uppercase keys inside them

    -

    Methods

    • Determines if the config file is read/write accessible. Returns true if the user has capabilities specified +

    Methods

    • Determines if the config file is read/write accessible. Returns true if the user has capabilities specified +

    Returns Promise<boolean>

    • Add a package alias to the project. +

    Returns boolean

    • Add a package alias to the project. If the alias already exists, it will be overwritten.

      -

      Parameters

      • alias: string
      • id: string

      Returns void

    • Add a package directory to the project. +

      Parameters

      • alias: string
      • id: string

      Returns void

    • Add a package directory to the project. If the package directory already exists, the new directory properties will be merged with the existing properties.

      -

      Parameters

      • packageDir: PackageDir

      Returns void

    • Check to see if the config file exists. Returns true if the config file exists and has access, false otherwise.

      -

      Returns Promise<boolean>

    • Invokes actionFn once for each key-value pair present in the config object.

      +

      Parameters

      • packageDir: PackageDir

      Returns void

    • Check to see if the config file exists. Returns true if the config file exists and has access, false otherwise.

      +

      Returns Promise<boolean>

    • Invokes actionFn once for each key-value pair present in the config object.

      Parameters

      • actionFn: ((key, value) => void)

        The function (key: string, value: ConfigValue) => void to be called for each element.

        -
          • (key, value): void
          • Parameters

            • key: string
            • value: AnyJson

            Returns void

      Returns void

    • Returns the value associated to the key, or undefined if there is none.

      +
        • (key, value): void
        • Parameters

          • key: string
          • value: AnyJson

          Returns void

    Returns void

    • Returns the value associated to the key, or undefined if there is none.

      Type Parameters

      • K extends string

      Parameters

      • key: K

        The key (object property)

      • Optional decrypt: boolean

        If it is an encrypted key, decrypt the value. If the value is an object, a clone will be returned.

        -

      Returns ProjectJson[K]

    • Type Parameters

      • V = AnyJson

      Parameters

      • key: string
      • Optional decrypt: boolean

      Returns V

    • Returns the entire config contents.

      +

    Returns ProjectJson[K]

  • Type Parameters

    • V = AnyJson

    Parameters

    • key: string
    • Optional decrypt: boolean

    Returns V

    • Returns the entire config contents.

      NOTE: Data will still be encrypted unless decrypt is passed in. A clone of the data will be returned to prevent storing un-encrypted data in memory and potentially saving to the file system.

      -

      Parameters

      • decrypt: boolean = false

      Returns Readonly<ProjectJson>

    • Get package aliases defined in the project.

      -

      Returns Nullable<Dictionary<string>>

    • Returns the packageDirectories within sfdx-project.json, first reading +

    Returns string[]

    • Get package aliases defined in the project.

      +

      Returns Nullable<Dictionary<string>>

    • Returns the packageDirectories within sfdx-project.json, first reading and validating the file if necessary.

      -

      Returns Promise<PackageDir[]>

    • Returns a read-only list of packageDirectories within sfdx-project.json, first reading +

      Returns Promise<PackageDir[]>

    • Returns a read-only list of packageDirectories within sfdx-project.json, first reading and validating the file if necessary. i.e. modifying this array will not affect the sfdx-project.json file.

      -

      Returns NamedPackageDir[]

    • Returns the absolute path to the config file.

      The first time getPath is called, the path is resolved and becomes immutable. This allows implementers to override options properties, like filePath, on the init method for async creation. If that is required for creation, the config files can not be synchronously created.

      -

      Returns string

    • Returns a read-only list of packageDirectories within sfdx-project.json, first reading and validating the file if necessary. i.e. modifying this array will not affect the sfdx-project.json file.

      There can be multiple packages in packageDirectories that point to the same directory. This method only returns one packageDirectory entry per unique directory path. This is useful when doing source operations based on directories but probably not as useful for packaging operations that want to do something for each package entry.

      -

      Returns NamedPackageDir[]

    • Returns a boolean asserting whether a value has been associated to the key in the config object or not.

      -

      Parameters

      • key: string

      Returns boolean

    • Has multiple package directories (MPD) defined in the project.

      -

      Returns boolean

    • Has at least one package alias defined in the project.

      -

      Returns Promise<boolean>

    • Has package directories defined in the project.

      -

      Returns boolean

    • Read the config file and set the config contents. Returns the config contents of the config file. As an +

      Returns string[]

    • Returns a boolean asserting whether a value has been associated to the key in the config object or not.

      +

      Parameters

      • key: string

      Returns boolean

    • Has multiple package directories (MPD) defined in the project.

      +

      Returns boolean

    • Has at least one package alias defined in the project.

      +

      Returns Promise<boolean>

    • Has package directories defined in the project.

      +

      Returns boolean

    • Read the config file and set the config contents. Returns the config contents of the config file. As an optimization, files are only read once per process and updated in memory and via write(). To force a read from the filesystem pass force=true. Throws SfError{ name: 'UnexpectedJsonFileFormat' } There was a problem reading or parsing the file.

      -

      Returns Promise<ProjectJson>

    • Read the config file and set the config contents. Returns the config contents of the config file. As an optimization, files are only read once per process and updated in memory and via write(). To force a read from the filesystem pass force=true. Throws SfError{ name: 'UnexpectedJsonFileFormat' } There was a problem reading or parsing the file.

      -

      Returns ProjectJson

    • Validates sfdx-project.json against the schema.

      +

      Returns Promise<void>

    • Sets the value for the key in the config object. This will override the existing value. +

      Returns void

    • Sets the value for the key in the config object. This will override the existing value. To do a partial update, use BaseConfigStore.update.

      Type Parameters

      • K extends string

      Parameters

      Returns void

    • Convert an object to a ConfigContents and set it as the config contents.

      +

    Returns void

    • Get the stats of the file. Returns the stats of the file.

      +

    Returns void

    • Delete the config file if it exists.

      Throws Error{ name: 'TargetFileNotFound' } If the ConfigFile.getFilename file is not found. fs.unlink

      -

      Returns Promise<void>

    • Delete the config file if it exists.

      Throws Error{ name: 'TargetFileNotFound' } If the ConfigFile.getFilename file is not found. fs.unlink

      -

      Returns void

    • Returns true if an element in the config object existed and has been removed, or false if the element does not exist. BaseConfigStore.has will return false afterwards.

      Type Parameters

      • K extends string

      Parameters

      • key: K

        The key

        -

      Returns boolean

    • Returns true if all elements in the config object existed and have been removed, or false if all the elements +

    Returns boolean

    • Returns true if all elements in the config object existed and have been removed, or false if all the elements do not exist (some may have been removed). BaseConfigStore.has(key) will return false afterwards.

      Parameters

      • keys: string[]

        The keys

        -

      Returns boolean

    • Updates the value for the key in the config object. If the value is an object, it +

    Returns boolean

    • Updates the value for the key in the config object. If the value is an object, it will be merged with the existing object.

      Type Parameters

      • K extends string

      Parameters

      Returns void

    • Write the config file with new contents. If no new contents are provided it will write the existing config +

    Returns void

    • Write the config file with new contents. If no new contents are provided it will write the existing config contents that were set from ConfigFile.read, or an empty file if ConfigFile.read was not called.

      -

      Returns Promise<ProjectJson>

    • Write the config file with new contents. If no new contents are provided it will write the existing config contents that were set from ConfigFile.read, or an empty file if ConfigFile.read was not called.

      -

      Returns ProjectJson

    • Helper used to determine what the local and global folder point to. Returns the file path of the root folder.

      +

    Returns ConfigFile.Options

    • Helper used to determine what the local and global folder point to. Returns the file path of the root folder.

      Parameters

      • isGlobal: boolean

        True if the config should be global. False for local.

        -

      Returns Promise<string>

    • Helper used to determine what the local and global folder point to. Returns the file path of the root folder.

      +

    Returns Promise<string>

    • Helper used to determine what the local and global folder point to. Returns the file path of the root folder.

      Parameters

      • isGlobal: boolean

        True if the config should be global. False for local.

        -

      Returns string

    \ No newline at end of file +

    Returns string

    \ No newline at end of file diff --git a/classes/stateAggregator_accessors_aliasAccessor.AliasAccessor.html b/classes/stateAggregator_accessors_aliasAccessor.AliasAccessor.html index 237d360a0..709071233 100644 --- a/classes/stateAggregator_accessors_aliasAccessor.AliasAccessor.html +++ b/classes/stateAggregator_accessors_aliasAccessor.AliasAccessor.html @@ -1,4 +1,4 @@ -AliasAccessor | @salesforce/core

    Hierarchy

    • AsyncOptionalCreatable
      • AliasAccessor

    Constructors

    constructor +AliasAccessor | @salesforce/core

    Hierarchy

    • AsyncOptionalCreatable
      • AliasAccessor

    Constructors

    Methods

    get getAll getUsername @@ -14,29 +14,29 @@

    Parameters

    • Optional options: object

      An options object providing initialization params.

    Returns AliasAccessor

    Methods

    Returns Nullable<string>

    • Returns the username that corresponds to the given alias if it exists

      +

    Returns string[]

    • Returns the username that corresponds to the given alias if it exists

      Parameters

      • alias: string

        the alias that corresponds to a username

        -

      Returns Nullable<string>

    • Returns the value that corresponds to the given alias if it exists

      +

    Returns Nullable<string>

    • Returns the value that corresponds to the given alias if it exists

      Parameters

      • alias: string

        the alias that corresponds to a value

        -

      Returns Nullable<string>

    • Returns true if the provided alias exists

      +

    Returns Nullable<string>

    • If the provided string is an alias, return it. +

    Returns boolean

    • If the provided string is an alias, return it. If the provided string is not an alias, return the username of the provided alias

      This method is helpful when you don't know if the string you have is a username or an alias.

      Parameters

      • usernameOrAlias: string

        a string that might be a username or might be an alias

        -

      Returns undefined | string

    • If the provided string is an alias, it returns the corresponding username. +

    Returns undefined | string

    • If the provided string is an alias, it returns the corresponding username. If the provided string is not an alias, we assume that the provided string is the username and return it.

      This method is helpful when you don't know if the string you have is a username or an alias.

      Parameters

      • usernameOrAlias: string

        a string that might be a username or might be an alias

        -

      Returns string

    • Set an alias for the given aliasable entity. Writes to the file

      +

    Returns string

    • Set an alias for the given aliasable entity. Writes to the file

      Parameters

      • alias: string

        the alias you want to set

      • entity: Aliasable

        the aliasable entity that's being aliased

        -

      Returns Promise<void>

    \ No newline at end of file +

    Returns Promise<void>

    \ No newline at end of file diff --git a/classes/stateAggregator_accessors_orgAccessor.BaseOrgAccessor.html b/classes/stateAggregator_accessors_orgAccessor.BaseOrgAccessor.html index 841af9180..838217880 100644 --- a/classes/stateAggregator_accessors_orgAccessor.BaseOrgAccessor.html +++ b/classes/stateAggregator_accessors_orgAccessor.BaseOrgAccessor.html @@ -1,4 +1,4 @@ -BaseOrgAccessor | @salesforce/core

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor +BaseOrgAccessor | @salesforce/core

    Type Parameters

    Hierarchy (view full)

    Constructors

    Methods

    exists get getAll @@ -16,26 +16,26 @@ New subclass instances must be created with the static create method.

    Type Parameters

    Parameters

    • Optional options: object

      An options object providing initialization params.

    Returns BaseOrgAccessor<T, P>

    Methods

    • Returns true if there is an auth file for the given username. The read or readAll methods must be called first in order to populate the cache.

      -

      Parameters

      • username: string

      Returns Promise<boolean>

    • Return the contents of the username's auth file from cache. The read or readAll methods must be called first in order to populate the cache. If throwOnNotFound is not true, an empty object {} is returned if the org is not found.

      Parameters

      • username: string

        username to get

      • Optional decrypt: boolean

        if true, decrypt encrypted values

      • Optional throwOnNotFound: true

        if true, throw if the auth file does not already exist in the cache

        -

      Returns P

    • Return the contents of all the auth files from cache. The read or readAll methods must be called first in order to populate the cache.

      +

    Returns P

    • Return the contents of all the auth files from cache. The read or readAll methods must be called first in order to populate the cache.

      Parameters

      • decrypt: boolean = false

        if true, decrypt encrypted values

        -

      Returns P[]

    • Read the auth file for the given username. Once the file has been read, it can be re-accessed with the get method.

      +

    Returns P[]

    • Read the auth file for the given username. Once the file has been read, it can be re-accessed with the get method.

      Parameters

      • username: string

        username to read

      • decrypt: boolean = false

        if true, decrypt encrypted values

      • throwOnNotFound: boolean = true

        throw if file is not found for username

        -

      Returns Promise<Nullable<P>>

    • Read all the auth files under the global state directory

      +

    Returns Promise<Nullable<P>>

    \ No newline at end of file +

    Returns Promise<P[]>

    \ No newline at end of file diff --git a/classes/stateAggregator_accessors_orgAccessor.OrgAccessor.html b/classes/stateAggregator_accessors_orgAccessor.OrgAccessor.html index 2d49ac220..49ebcb051 100644 --- a/classes/stateAggregator_accessors_orgAccessor.OrgAccessor.html +++ b/classes/stateAggregator_accessors_orgAccessor.OrgAccessor.html @@ -1,4 +1,4 @@ -OrgAccessor | @salesforce/core

    Hierarchy (view full)

    Constructors

    constructor +OrgAccessor | @salesforce/core

    Hierarchy (view full)

    Constructors

    Methods

    exists get getAll @@ -16,26 +16,26 @@ New subclass instances must be created with the static create method.

    Parameters

    • Optional options: object

      An options object providing initialization params.

    Returns OrgAccessor

    Methods

    • Return the contents of the username's auth file from cache. The read or readAll methods must be called first in order to populate the cache. If throwOnNotFound is not true, an empty object {} is returned if the org is not found.

      Parameters

      • username: string

        username to get

      • Optional decrypt: boolean

        if true, decrypt encrypted values

      • Optional throwOnNotFound: true

        if true, throw if the auth file does not already exist in the cache

        -

      Returns AuthFields

    • Return the contents of all the auth files from cache. The read or readAll methods must be called first in order to populate the cache.

      +

    Returns AuthFields

    • Read the auth file for the given username. Once the file has been read, it can be re-accessed with the get method.

      +

    Returns AuthFields[]

    • Read the auth file for the given username. Once the file has been read, it can be re-accessed with the get method.

      Parameters

      • username: string

        username to read

      • decrypt: boolean = false

        if true, decrypt encrypted values

      • throwOnNotFound: boolean = true

        throw if file is not found for username

        -

      Returns Promise<Nullable<AuthFields>>

    • Read all the auth files under the global state directory

      +

    Returns Promise<Nullable<AuthFields>>

    \ No newline at end of file +

    Returns Promise<AuthFields[]>

    \ No newline at end of file diff --git a/classes/stateAggregator_accessors_sandboxAccessor.SandboxAccessor.html b/classes/stateAggregator_accessors_sandboxAccessor.SandboxAccessor.html index 9dcf6408a..0179ab571 100644 --- a/classes/stateAggregator_accessors_sandboxAccessor.SandboxAccessor.html +++ b/classes/stateAggregator_accessors_sandboxAccessor.SandboxAccessor.html @@ -1,4 +1,4 @@ -SandboxAccessor | @salesforce/core

    Hierarchy (view full)

    Constructors

    constructor +SandboxAccessor | @salesforce/core

    Hierarchy (view full)

    Constructors

    Methods

    exists get getAll @@ -16,26 +16,26 @@ New subclass instances must be created with the static create method.

    Parameters

    • Optional options: object

      An options object providing initialization params.

    Returns SandboxAccessor

    Methods

    • Return the contents of the username's auth file from cache. The read or readAll methods must be called first in order to populate the cache. If throwOnNotFound is not true, an empty object {} is returned if the org is not found.

      Parameters

      • username: string

        username to get

      • Optional decrypt: boolean

        if true, decrypt encrypted values

      • Optional throwOnNotFound: true

        if true, throw if the auth file does not already exist in the cache

        -

      Returns SandboxFields

    • Return the contents of all the auth files from cache. The read or readAll methods must be called first in order to populate the cache.

      +

    Returns SandboxFields

    • Read the auth file for the given username. Once the file has been read, it can be re-accessed with the get method.

      +

    Returns SandboxFields[]

    • Read the auth file for the given username. Once the file has been read, it can be re-accessed with the get method.

      Parameters

      • username: string

        username to read

      • decrypt: boolean = false

        if true, decrypt encrypted values

      • throwOnNotFound: boolean = true

        throw if file is not found for username

        -

      Returns Promise<Nullable<SandboxFields>>

    • Read all the auth files under the global state directory

      +

    Returns Promise<Nullable<SandboxFields>>

    \ No newline at end of file +

    Returns Promise<SandboxFields[]>

    \ No newline at end of file diff --git a/classes/stateAggregator_stateAggregator.StateAggregator.html b/classes/stateAggregator_stateAggregator.StateAggregator.html index 256b6a24a..f5892da1a 100644 --- a/classes/stateAggregator_stateAggregator.StateAggregator.html +++ b/classes/stateAggregator_stateAggregator.StateAggregator.html @@ -1,4 +1,4 @@ -StateAggregator | @salesforce/core

    Hierarchy

    • AsyncOptionalCreatable
      • StateAggregator

    Constructors

    constructor +StateAggregator | @salesforce/core

    Hierarchy

    • AsyncOptionalCreatable
      • StateAggregator

    Constructors

    Properties

    aliases orgs sandboxes @@ -7,9 +7,9 @@

    Constructors

    • Constructs a new AsyncCreatable instance. For internal and subclass use only. New subclass instances must be created with the static create method.

      Parameters

      • Optional options: object

        An options object providing initialization params.

        -

      Returns StateAggregator

    Properties

    aliases: AliasAccessor
    sandboxes: SandboxAccessor

    Methods

    • Clear the cache to force reading from disk.

      +

    Returns StateAggregator

    Properties

    aliases: AliasAccessor
    sandboxes: SandboxAccessor

    Methods

    • Clear the cache to force reading from disk.

      NOTE: Only call this method if you must and you know what you are doing.

      -

      Parameters

      • path: string = Global.DIR

      Returns void

    \ No newline at end of file +

    Returns Promise<StateAggregator>

    \ No newline at end of file diff --git a/classes/status_myDomainResolver.MyDomainResolver-1.html b/classes/status_myDomainResolver.MyDomainResolver-1.html index 9c0520a66..070219fbc 100644 --- a/classes/status_myDomainResolver.MyDomainResolver-1.html +++ b/classes/status_myDomainResolver.MyDomainResolver-1.html @@ -2,7 +2,7 @@ Salesforce DNS service. This service is not exclusive to Salesforce My Domain URL and could be used for any hostname.

    (async () => {
    const options: MyDomainResolver.Options = {
    url: new URL('http://mydomain.salesforce.com'),
    timeout: Duration.minutes(5),
    frequency: Duration.seconds(10)
    };
    const resolver: MyDomainResolver = await MyDomainResolver.create(options);
    const ipAddress: AnyJson = await resolver.resolve();
    console.log(`Successfully resolved host: ${options.url} to address: ${ipAddress}`);
    })();
    -

    Hierarchy

    Constructors

    Hierarchy

    Constructors

    Properties

    Methods

    getCnames getFrequency @@ -11,8 +11,8 @@

    Constructors

    Properties

    DEFAULT_DOMAIN: URL = ...

    Methods

    • Method that performs the dns lookup of the host. If the lookup fails the internal polling client will try again +

    Returns MyDomainResolver

    Properties

    DEFAULT_DOMAIN: URL = ...

    Methods

    • Method that performs the dns lookup of the host. If the lookup fails the internal polling client will try again given the optional interval. Returns the resolved ip address.

      If SFDX_DISABLE_DNS_CHECK environment variable is set to true, it will immediately return the host without executing the dns loookup.

      -

      Returns Promise<string>

    \ No newline at end of file +

    Returns Promise<string>

    \ No newline at end of file diff --git a/classes/status_pollingClient.PollingClient-1.html b/classes/status_pollingClient.PollingClient-1.html index d4b60da33..784e89a28 100644 --- a/classes/status_pollingClient.PollingClient-1.html +++ b/classes/status_pollingClient.PollingClient-1.html @@ -3,9 +3,9 @@ want to use this? It can impact Salesforce API usage.

    const options: PollingClient.Options = {
    async poll(): Promise<StatusResult> {
    return Promise.resolve({ completed: true, payload: 'Hello World' });
    },
    frequency: Duration.milliseconds(10),
    timeout: Duration.minutes(1)
    };
    const client = await PollingClient.create(options);
    const pollResult = await client.subscribe();
    console.log(`pollResult: ${pollResult}`);
    -

    Hierarchy

    Methods

    Hierarchy

    Methods

    Methods

    • Returns a promise to call the specified polling function using the interval and timeout specified +

      Returns Promise<void>

    • Returns a promise to call the specified polling function using the interval and timeout specified in the polling options.

      -

      Type Parameters

      • T = AnyJson

      Returns Promise<T>

    \ No newline at end of file +

    Type Parameters

    • T = AnyJson

    Returns Promise<T>

    \ No newline at end of file diff --git a/classes/status_pollingClient.PollingClient.DefaultPollingOptions.html b/classes/status_pollingClient.PollingClient.DefaultPollingOptions.html index e23f82f7d..ecb24dc63 100644 --- a/classes/status_pollingClient.PollingClient.DefaultPollingOptions.html +++ b/classes/status_pollingClient.PollingClient.DefaultPollingOptions.html @@ -1,10 +1,10 @@ DefaultPollingOptions | @salesforce/core

    Default options set for polling. The default options specify a timeout of 3 minutes and polling frequency of 15 seconds;

    -

    Implements

    Constructors

    Implements

    Constructors

    Properties

    Constructors

    Properties

    frequency: Duration
    poll: (() => Promise<StatusResult>)

    Type declaration

    timeout: Duration
    \ No newline at end of file +

    Returns DefaultPollingOptions

    Properties

    frequency: Duration
    poll: (() => Promise<StatusResult>)

    Type declaration

    timeout: Duration
    \ No newline at end of file diff --git a/classes/status_streamingClient.StreamingClient-1.html b/classes/status_streamingClient.StreamingClient-1.html index e3b9420bf..21a473f8a 100644 --- a/classes/status_streamingClient.StreamingClient-1.html +++ b/classes/status_streamingClient.StreamingClient-1.html @@ -17,7 +17,7 @@ policy goes into effect.

    const streamProcessor = (message: JsonMap): StatusResult => {
    const payload = ensureJsonMap(message.payload);
    const id = ensureString(payload.id);

    if (payload.status !== 'Active') {
    return { completed: false };
    }

    return {
    completed: true,
    payload: id
    };
    };

    const org = await Org.create();
    const options = new StreamingClient.DefaultOptions(org, 'MyPushTopics', streamProcessor);

    const asyncStatusClient = await StreamingClient.create(options);

    await asyncStatusClient.handshake();

    const info: RequestInfo = {
    method: 'POST',
    url: `${org.getField(OrgFields.INSTANCE_URL)}/SomeService`,
    headers: { HEADER: 'HEADER_VALUE'},
    body: 'My content'
    };

    await asyncStatusClient.subscribe(async () => {
    const connection = await org.getConnection();
    // Now that we are subscribed, we can initiate the request that will cause the events to start streaming.
    const requestResponse: JsonCollection = await connection.request(info);
    const id = ensureJsonMap(requestResponse).id;
    console.log(`this.id: ${JSON.stringify(ensureString(id), null, 4)}`);
    });
    -

    Hierarchy

    Constructors

    Hierarchy

    Constructors

    Methods

    handshake init replay @@ -25,13 +25,13 @@

    Constructors

    Methods

    • Allows replaying of of Streaming events starting with replayId.

      +

    Returns StreamingClient

    Methods

    • Allows replaying of of Streaming events starting with replayId.

      Parameters

      • replayId: number

        The starting message id to replay from.

        -

      Returns void

    • Subscribe to streaming events. When the streaming processor that's set in the options completes execution it +

    Returns void

    • Subscribe to streaming events. When the streaming processor that's set in the options completes execution it returns a payload in the StatusResult object. The payload is just echoed here for convenience.

      Throws SfError{ name: 'StreamingClient.TimeoutErrorType.SUBSCRIBE'} When the subscribe timeout occurs.

      Parameters

      • Optional streamInit: (() => Promise<void>)

        This function should call the platform apis that result in streaming updates on push topics. StatusResult

        -
          • (): Promise<void>
          • Returns Promise<void>

      Returns Promise<void | AnyJson>

    \ No newline at end of file +
      • (): Promise<void>
      • Returns Promise<void>

    Returns Promise<void | AnyJson>

    \ No newline at end of file diff --git a/classes/status_streamingClient.StreamingClient.DefaultOptions.html b/classes/status_streamingClient.StreamingClient.DefaultOptions.html index f4da59ceb..772435178 100644 --- a/classes/status_streamingClient.StreamingClient.DefaultOptions.html +++ b/classes/status_streamingClient.StreamingClient.DefaultOptions.html @@ -1,5 +1,5 @@ DefaultOptions | @salesforce/core

    Default Streaming Options. Uses Faye as the cometd impl.

    -

    Implements

    Constructors

    Implements

    Constructors

    Properties

    apiVersion channel handshakeTimeout @@ -19,19 +19,19 @@ System topics are deprecated.

  • streamProcessor: StreamProcessor

    The function called that can process streaming messages.

  • envDep: Env = env
  • Returns DefaultOptions

    Properties

    apiVersion: string

    The salesforce api version

    -
    channel: string

    The streaming channel aka topic

    -
    handshakeTimeout: Duration

    The hard timeout that happens with a handshake.

    -
    org: Org

    The org streaming target.

    -
    streamProcessor: StreamProcessor

    The function for processing streaming messages

    -
    streamingImpl: StreamingClientIfc

    The function for build the inner client impl. Allows for mocking.

    -
    subscribeTimeout: Duration

    The hard timeout that happens with subscribe

    -
    DEFAULT_HANDSHAKE_TIMEOUT: Duration = ...
    DEFAULT_SUBSCRIBE_TIMEOUT: Duration = ...
    SFDX_ENABLE_FAYE_COOKIES_ALLOW_ALL_PATHS: "SFDX_ENABLE_FAYE_REQUEST_RESPONSE_LOGGING" = 'SFDX_ENABLE_FAYE_REQUEST_RESPONSE_LOGGING'
    SFDX_ENABLE_FAYE_REQUEST_RESPONSE_LOGGING: "SFDX_ENABLE_FAYE_REQUEST_RESPONSE_LOGGING" = 'SFDX_ENABLE_FAYE_REQUEST_RESPONSE_LOGGING'

    Methods

    Properties

    apiVersion: string

    The salesforce api version

    +
    channel: string

    The streaming channel aka topic

    +
    handshakeTimeout: Duration

    The hard timeout that happens with a handshake.

    +
    org: Org

    The org streaming target.

    +
    streamProcessor: StreamProcessor

    The function for processing streaming messages

    +
    streamingImpl: StreamingClientIfc

    The function for build the inner client impl. Allows for mocking.

    +
    subscribeTimeout: Duration

    The hard timeout that happens with subscribe

    +
    DEFAULT_HANDSHAKE_TIMEOUT: Duration = ...
    DEFAULT_SUBSCRIBE_TIMEOUT: Duration = ...
    SFDX_ENABLE_FAYE_COOKIES_ALLOW_ALL_PATHS: "SFDX_ENABLE_FAYE_REQUEST_RESPONSE_LOGGING" = 'SFDX_ENABLE_FAYE_REQUEST_RESPONSE_LOGGING'
    SFDX_ENABLE_FAYE_REQUEST_RESPONSE_LOGGING: "SFDX_ENABLE_FAYE_REQUEST_RESPONSE_LOGGING" = 'SFDX_ENABLE_FAYE_REQUEST_RESPONSE_LOGGING'

    Methods

    • Setter for the subscribe timeout.

      +

    Returns void

    \ No newline at end of file +

    Returns void

    \ No newline at end of file diff --git a/classes/status_types.CometClient.html b/classes/status_types.CometClient.html index fe085b41e..c21cdb023 100644 --- a/classes/status_types.CometClient.html +++ b/classes/status_types.CometClient.html @@ -1,6 +1,6 @@ CometClient | @salesforce/core

    Class CometClientAbstract

    Comet client interface. The is to allow for mocking the inner streaming Cometd implementation. The Faye implementation is used by default but it could be used to adapt another Cometd impl.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Methods

    Constructors

    • Parameters

      • Optional options: EventEmitterOptions

      Returns CometClient

    Methods

    • Add a custom extension to the underlying client.

      Parameters

      Returns void

    • Disable polling features.

      +

    Returns void

    • Disable polling features.

      Parameters

      • label: string

        Polling feature label.

        -

      Returns void

    • Method to call to disconnect the client from the server.

      -

      Returns void

    • handshake with the streaming channel

      +

    Returns void

    • Method to call to disconnect the client from the server.

      +

      Returns void

    • handshake with the streaming channel

      Parameters

      • callback: (() => void)

        Callback for the handshake when it successfully completes. The handshake should throw errors when errors are encountered.

        -
          • (): void
          • Returns void

      Returns void

    • Sets an http header name/value.

      +
        • (): void
        • Returns void

    Returns void

    • Sets an http header name/value.

      Parameters

      • name: string

        The header name.

      • value: string

        The header value.

        -

      Returns void

    • Subscribes to Comet topics. Subscribe should perform a handshake if one hasn't been performed yet.

      +

    Returns void

    • Subscribes to Comet topics. Subscribe should perform a handshake if one hasn't been performed yet.

      Parameters

      • channel: string

        The topic to subscribe to.

      • callback: ((message) => void)

        The callback to execute once a message has been received.

        -
          • (message): void
          • Parameters

            • message: JsonMap

            Returns void

      Returns CometSubscription

    \ No newline at end of file +
      • (message): void
      • Parameters

        • message: JsonMap

        Returns void

    Returns CometSubscription

    \ No newline at end of file diff --git a/classes/testSetup.MockTestOrgData.html b/classes/testSetup.MockTestOrgData.html index f97d12cf7..d79db89e8 100644 --- a/classes/testSetup.MockTestOrgData.html +++ b/classes/testSetup.MockTestOrgData.html @@ -1,7 +1,7 @@ MockTestOrgData | @salesforce/core

    Mock class for Salesforce Orgs.

    Example

    const testOrg = new MockTestOrgData();
    await $$.stubAuths(testOrg)
    -

    Constructors

    Constructors

    Properties

    accessToken: string
    aliases?: string[]
    authcode: string
    clientId: string
    clientSecret: string
    configs?: string[]
    devHubUsername?: string
    instanceUrl: string
    isDevHub?: boolean
    isExpired?: boolean | "unknown"
    isScratchOrg?: boolean
    loginUrl: string
    namespacePrefix?: string
    orgId: string
    password?: string
    redirectUri: string
    refreshToken: undefined | string
    testId: string
    tracksSource: undefined | boolean
    userId: string
    username: string

    Methods

    • Add devhub username to properties.

      -

      Parameters

      • username: string

      Returns void

    • Return mock user information based on this org.

      -

      Returns MockUserInfo

    \ No newline at end of file +

    Constructors

    Properties

    accessToken: string
    aliases?: string[]
    authcode: string
    clientId: string
    clientSecret: string
    configs?: string[]
    devHubUsername?: string
    instanceUrl: string
    isDevHub?: boolean
    isExpired?: boolean | "unknown"
    isScratchOrg?: boolean
    loginUrl: string
    namespacePrefix?: string
    orgId: string
    password?: string
    redirectUri: string
    refreshToken: undefined | string
    testId: string
    tracksSource: undefined | boolean
    userId: string
    username: string

    Methods

    • Add devhub username to properties.

      +

      Parameters

      • username: string

      Returns void

    • Return mock user information based on this org.

      +

      Returns MockUserInfo

    \ No newline at end of file diff --git a/classes/testSetup.MockTestSandboxData.html b/classes/testSetup.MockTestSandboxData.html index ff28e65a8..73e21405e 100644 --- a/classes/testSetup.MockTestSandboxData.html +++ b/classes/testSetup.MockTestSandboxData.html @@ -1,12 +1,12 @@ MockTestSandboxData | @salesforce/core

    Mock class for Salesforce Sandboxes.

    Example

    const testOrg = new MockTestSandboxData();
    await $$.stubSandboxes(testOrg)
    -

    Constructors

    Constructors

    Properties

    id: string = ...
    prodOrgUsername: string
    sandboxName?: string
    sandboxOrgId: string
    username?: string

    Methods

    \ No newline at end of file +

    Constructors

    Properties

    id: string = ...
    prodOrgUsername: string
    sandboxName?: string
    sandboxOrgId: string
    username?: string

    Methods

    \ No newline at end of file diff --git a/classes/testSetup.StreamingMockCometClient.html b/classes/testSetup.StreamingMockCometClient.html index 45afd2cd5..d580e0a86 100644 --- a/classes/testSetup.StreamingMockCometClient.html +++ b/classes/testSetup.StreamingMockCometClient.html @@ -1,7 +1,7 @@ StreamingMockCometClient | @salesforce/core

    Simulates a comet client. To the core streaming client this mocks the internal comet impl. The uses setTimeout(0ms) event loop phase just so the client can simulate actual streaming without the response latency.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Methods

    Constructors

    Methods

    • Fake handshake that invoke callback after the setTimeout event phase.

      +

    Returns StreamingMockCometClient

    Methods

    • Fake handshake that invoke callback after the setTimeout event phase.

      Parameters

      • callback: (() => void)

        The function to invoke.

        -
          • (): void
          • Returns void

      Returns void

    • Fake subscription that completed after the setTimout event phase.

      +
        • (): void
        • Returns void

    Returns void

    • Fake subscription that completed after the setTimout event phase.

      Parameters

      • channel: string

        The streaming channel.

      • callback: ((message) => void)

        The function to invoke after the subscription completes.

        -
          • (message): void
          • Parameters

            • message: JsonMap

            Returns void

      Returns CometSubscription

    \ No newline at end of file +
      • (message): void
      • Parameters

        • message: JsonMap

        Returns void

    Returns CometSubscription

    \ No newline at end of file diff --git a/classes/testSetup.StreamingMockCometSubscription.html b/classes/testSetup.StreamingMockCometSubscription.html index 46fc0ea83..df9056793 100644 --- a/classes/testSetup.StreamingMockCometSubscription.html +++ b/classes/testSetup.StreamingMockCometSubscription.html @@ -1,11 +1,11 @@ StreamingMockCometSubscription | @salesforce/core

    Simulates a comet subscription to a streaming channel.

    -

    Hierarchy

    • EventEmitter
      • StreamingMockCometSubscription

    Implements

    Constructors

    Hierarchy

    • EventEmitter
      • StreamingMockCometSubscription

    Implements

    Constructors

    Properties

    SUBSCRIPTION_COMPLETE: string = 'subscriptionComplete'
    SUBSCRIPTION_FAILED: string = 'subscriptionFailed'

    Methods

    • Sets up a streaming subscription callback to occur after the setTimeout event loop phase.

      +

    Constructors

    Properties

    SUBSCRIPTION_COMPLETE: string = 'subscriptionComplete'
    SUBSCRIPTION_FAILED: string = 'subscriptionFailed'

    Methods

    • Sets up a streaming subscription callback to occur after the setTimeout event loop phase.

      Parameters

      • callback: (() => void)

        The function to invoke.

        -
          • (): void
          • Returns void

      Returns void

    • Sets up a streaming subscription errback to occur after the setTimeout event loop phase.

      +
        • (): void
        • Returns void

    Returns void

    • Sets up a streaming subscription errback to occur after the setTimeout event loop phase.

      Parameters

      • callback: ((error) => void)

        The function to invoke.

        -
          • (error): void
          • Parameters

            • error: Error

            Returns void

      Returns void

    \ No newline at end of file +
      • (error): void
      • Parameters

        • error: Error

        Returns void

    Returns void

    \ No newline at end of file diff --git a/classes/testSetup.TestContext.html b/classes/testSetup.TestContext.html index b11a44ab3..1e40001bd 100644 --- a/classes/testSetup.TestContext.html +++ b/classes/testSetup.TestContext.html @@ -1,5 +1,5 @@ TestContext | @salesforce/core

    Instantiate a @salesforce/core test context.

    -

    Constructors

    Constructors

    Properties

    Constructors

    • Parameters

      • options: {
            sandbox?: SinonSandbox;
            setup?: boolean;
            sinon?: SinonStatic;
        } = {}
        • Optional sandbox?: SinonSandbox
        • Optional setup?: boolean
        • Optional sinon?: SinonStatic

      Returns TestContext

    Properties

    SANDBOX: SinonSandbox

    The default sandbox is cleared out before each test run.

    +

    Constructors

    • Parameters

      • options: {
            sandbox?: SinonSandbox;
            setup?: boolean;
            sinon?: SinonStatic;
        } = {}
        • Optional sandbox?: SinonSandbox
        • Optional setup?: boolean
        • Optional sinon?: SinonStatic

      Returns TestContext

    Properties

    SANDBOX: SinonSandbox

    The default sandbox is cleared out before each test run.

    See [sinon sandbox]https://sinonjs.org/releases/v14/sandbox/.

    -
    SANDBOXES: SandboxTypes

    An object of different sandboxes. Used when +

    SANDBOXES: SandboxTypes

    An object of different sandboxes. Used when needing to restore parts of the system for customized testing.

    -
    TEST_LOGGER: Logger

    The test logger that is used when Logger.child is used anywhere. It uses memory logging.

    -
    configStubs: {
        AuthInfoConfig?: ConfigStub;
        Config?: ConfigStub;
        OrgUsersConfig?: ConfigStub;
        SfProjectJson?: ConfigStub;
        [configName: string]: Optional<ConfigStub>;
    } = {}

    An object used in tests that interact with config files.

    -

    Type declaration

    id: string = ...

    id A unique id for the test run.

    -
    stubs: Record<string, SinonStub<any[], any>> = {}

    A record of stubs created during instantiation.

    -

    Methods

    • Used to mock http request to Salesforce.

      +
    TEST_LOGGER: Logger

    The test logger that is used when Logger.child is used anywhere. It uses memory logging.

    +
    configStubs: {
        AuthInfoConfig?: ConfigStub;
        Config?: ConfigStub;
        OrgUsersConfig?: ConfigStub;
        SfProjectJson?: ConfigStub;
        [configName: string]: Optional<ConfigStub>;
    } = {}

    An object used in tests that interact with config files.

    +

    Type declaration

    id: string = ...

    id A unique id for the test run.

    +
    stubs: Record<string, SinonStub<any[], any>> = {}

    A record of stubs created during instantiation.

    +

    Methods

    • Used to mock http request to Salesforce.

      Parameters

      • request: AnyJson

        An HttpRequest.

      • Optional options: AnyJson

        Additional options.

        See Connection.request

        -

      Returns Promise<AnyJson>

    • Gets a config stub contents by name.

      +

    Returns Promise<AnyJson>

    • Gets a config stub contents by name.

      Parameters

      • name: string

        The name of the config.

      • Optional group: string

        If the config supports groups.

        -

      Returns ConfigContents

    • A function used when resolving the global path. Calls globalPathResolverSync by default.

      +

    Returns ConfigContents

    • A function used when resolving the global path. Calls globalPathResolverSync by default.

      Parameters

      • uid: string

        Unique id.

        -

      Returns Promise<string>

    • A function used when resolving the global path.

      +

    Returns Promise<string>

    • A function used when resolving the global path.

      Parameters

      • uid: string

        Unique id.

        -

      Returns string

    • Set stubs for working in the context of a SfProject

      -

      Parameters

      • inProject: boolean = true

      Returns void

    • A function used when resolving the local path. Calls localPathResolverSync by default.

      +

    Returns string

    • Set stubs for working in the context of a SfProject

      +

      Parameters

      • inProject: boolean = true

      Returns void

    • A function used when resolving the local path. Calls localPathResolverSync by default.

      Parameters

      • uid: string

        Unique id.

        -

      Returns Promise<string>

    • A function used when resolving the local path.

      +

    Returns Promise<string>

    • A function used when resolving the local path.

      Parameters

      • uid: string

        Unique id.

        -

      Returns string

    • A function used for resolving paths. Calls localPathRetriever and globalPathRetriever.

      +

    Returns string

    • A function used for resolving paths. Calls localPathRetriever and globalPathRetriever.

      Parameters

      • isGlobal: boolean

        true if the config is global.

      • Optional uid: string

        user id.

        -

      Returns Promise<string>

    • A function used for resolving paths. Calls localPathRetrieverSync and globalPathRetrieverSync.

      +

    Returns Promise<string>

    • A function used for resolving paths. Calls localPathRetrieverSync and globalPathRetrieverSync.

      Parameters

      • isGlobal: boolean

        true if the config is global.

      • Optional uid: string

        user id.

        -

      Returns string

    • Sets a config stub contents by name

      +

    Returns string

    • Sets a config stub contents by name

      Parameters

      • name: string

        The name of the config stub.

      • value: ConfigContents

        The actual stub contents. The Mock data.

        -

      Returns void

    • Add beforeEach and afterEach hooks to init the stubs and restore them. +

    Returns void

    • Add beforeEach and afterEach hooks to init the stubs and restore them. This is called automatically when the class is instantiated unless the setup option is set to false.

      -

      Returns void

    • Stub the aliases in the global aliases config file.

      -

      Parameters

      • aliases: Record<string, string>
      • group: string = aliasAccessorEntireFile.DEFAULT_GROUP

      Returns void

    • Stub contents in the config file.

      -

      Parameters

      • config: Record<string, string>

      Returns Promise<void>

    • Stub salesforce user authorizations.

      +

      Returns void

    • Stub the aliases in the global aliases config file.

      +

      Parameters

      • aliases: Record<string, string>
      • group: string = aliasAccessorEntireFile.DEFAULT_GROUP

      Returns void

    • Stub contents in the config file.

      +

      Parameters

      • config: Record<string, string>

      Returns Promise<void>

    • Stub salesforce user authorizations.

      Parameters

      • users: Record<string, MockTestOrgData[]>

        The users to stub. The key is the username of the admin user and it must be included in the users array in order to obtain the orgId key for the remaining users. The admin user is excluded from the users array.

        -

      Returns void

    \ No newline at end of file +

    Returns void

    \ No newline at end of file diff --git a/classes/util_cache.Cache.html b/classes/util_cache.Cache.html index 78bd522d0..9ff9b4a42 100644 --- a/classes/util_cache.Cache.html +++ b/classes/util_cache.Cache.html @@ -1,8 +1,8 @@ -Cache | @salesforce/core

    Hierarchy

    • Map
      • Cache

    Accessors

    hits +Cache | @salesforce/core

    Hierarchy

    • Map
      • Cache

    Accessors

    Methods

    • Type Parameters

      • V

      Parameters

      • key: string

      Returns undefined | V

    • Type Parameters

      • V

      Parameters

      • key: string
      • value: V

      Returns void

    \ No newline at end of file +

    Accessors

    Methods

    • Type Parameters

      • V

      Parameters

      • key: string

      Returns undefined | V

    • Type Parameters

      • V

      Parameters

      • key: string
      • value: V

      Returns void

    \ No newline at end of file diff --git a/classes/util_directoryWriter.DirectoryWriter.html b/classes/util_directoryWriter.DirectoryWriter.html index b0b3fdedc..f3f3c8a13 100644 --- a/classes/util_directoryWriter.DirectoryWriter.html +++ b/classes/util_directoryWriter.DirectoryWriter.html @@ -1,6 +1,6 @@ -DirectoryWriter | @salesforce/core

    Implements

    Constructors

    constructor +DirectoryWriter | @salesforce/core

    Implements

    Constructors

    Accessors

    Methods

    • Parameters

      • contents: string | Buffer | Readable
      • targetPath: string

      Returns Promise<void>

    • Returns undefined | string

    \ No newline at end of file +

    Constructors

    Accessors

    Methods

    • Parameters

      • contents: string | Buffer | Readable
      • targetPath: string

      Returns Promise<void>

    • Returns undefined | string

    \ No newline at end of file diff --git a/classes/util_sfdcUrl.SfdcUrl.html b/classes/util_sfdcUrl.SfdcUrl.html index 275568193..d37900e7a 100644 --- a/classes/util_sfdcUrl.SfdcUrl.html +++ b/classes/util_sfdcUrl.SfdcUrl.html @@ -1,4 +1,4 @@ -SfdcUrl | @salesforce/core

    Hierarchy

    • URL
      • SfdcUrl

    Constructors

    constructor +SfdcUrl | @salesforce/core

    Hierarchy

    • URL
      • SfdcUrl

    Constructors

    Properties

    Methods

    Constructors

    Properties

    PRODUCTION: "https://login.salesforce.com" = 'https://login.salesforce.com'
    SANDBOX: "https://test.salesforce.com" = 'https://test.salesforce.com'

    Salesforce URLs

    -

    Methods

    • Tests whether this url has the lightning domain extension +

    Constructors

    Properties

    PRODUCTION: "https://login.salesforce.com" = 'https://login.salesforce.com'
    SANDBOX: "https://test.salesforce.com" = 'https://test.salesforce.com'

    Salesforce URLs

    +

    Methods

    • Tests whether this url has the lightning domain extension This method that performs the dns lookup of the host. If the lookup fails the internal polling (1 second), client will try again until timeout If SF_DOMAIN_RETRY environment variable is set (number) it overrides the default timeout duration (240 seconds)

      Returns Promise<true>

      The resolved ip address or never

      Throws

      SfError If can't resolve DNS.

      -
    • Returns the appropriate jwt audience url for this url +

    • Returns the appropriate jwt audience url for this url Use SF_AUDIENCE_URL env var to override the audience url

      Parameters

      • Optional createdOrgInstance: string

        The Salesforce instance the org was created on. e.g. cs42

      Returns Promise<string>

      The audience url

      -
    • Tests whether this url is an internal Salesforce domain

      +
    • Tests whether this url is an internal Salesforce domain

      Returns boolean

      true if this is an internal domain

      -
    • Test whether this url represents a lightning domain

      +
    • Test whether this url represents a lightning domain

      Returns boolean

      true if this domain is a lightning domain

      -
    • Tests whether this url runs on a local machine

      Returns boolean

      true if this is a local machine

      -
    • Tests whether this url contains a Salesforce owned domain

      +
    • Tests whether this url contains a Salesforce owned domain

      Returns boolean

      true if this is a salesforce domain

      -
    • Method that performs the dns lookup of the host. If the lookup fails the internal polling (1 second), client will try again until timeout +

    • Method that performs the dns lookup of the host. If the lookup fails the internal polling (1 second), client will try again until timeout If SF_DOMAIN_RETRY environment variable is set (number) it overrides the default timeout duration (240 seconds)

      Returns Promise<string>

      the resolved ip address.

      Throws

      SfError If can't resolve DNS.

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/classes/util_zipWriter.ZipWriter.html b/classes/util_zipWriter.ZipWriter.html index 07d3cac56..5087edcfd 100644 --- a/classes/util_zipWriter.ZipWriter.html +++ b/classes/util_zipWriter.ZipWriter.html @@ -1,6 +1,6 @@ -ZipWriter | @salesforce/core

    Hierarchy

    • Writable
      • ZipWriter

    Implements

    Constructors

    constructor +ZipWriter | @salesforce/core

    Hierarchy

    • Writable
      • ZipWriter

    Implements

    Constructors

    Accessors

    Methods

    • Parameters

      • contents: string | Buffer | Readable
      • path: string

      Returns Promise<void>

    • Returns Promise<void>

    • Returns undefined | string

    \ No newline at end of file +

    Constructors

    Accessors

    Methods

    • Parameters

      • contents: string | Buffer | Readable
      • path: string

      Returns Promise<void>

    • Returns Promise<void>

    • Returns undefined | string

    \ No newline at end of file diff --git a/classes/webOAuthServer.WebOAuthServer-1.html b/classes/webOAuthServer.WebOAuthServer-1.html index c9812818b..e66c2281b 100644 --- a/classes/webOAuthServer.WebOAuthServer-1.html +++ b/classes/webOAuthServer.WebOAuthServer-1.html @@ -2,14 +2,14 @@

    Usage:

    const oauthConfig = {
    loginUrl: this.flags.instanceurl,
    clientId: this.flags.clientid,
    };

    const oauthServer = await WebOAuthServer.create({ oauthConfig });
    await oauthServer.start();
    await open(oauthServer.getAuthorizationUrl(), { wait: false });
    const authInfo = await oauthServer.authorizeAndSave();
    -

    Hierarchy

    Constructors

    Hierarchy

    Constructors

    Properties

    DEFAULT_PORT: number = 1717

    Methods

    • Returns the authorization url that's used for the login flow

      -

      Returns string

    • Returns the configured oauthLocalPort or the WebOAuthServer.DEFAULT_PORT

      -

      Returns Promise<number>

    \ No newline at end of file +

    Constructors

    Properties

    DEFAULT_PORT: number = 1717

    Methods

    • Returns the authorization url that's used for the login flow

      +

      Returns string

    • Returns the configured oauthLocalPort or the WebOAuthServer.DEFAULT_PORT

      +

      Returns Promise<number>

    \ No newline at end of file diff --git a/classes/webOAuthServer.WebServer.html b/classes/webOAuthServer.WebServer.html index ab23b67d5..463636ee8 100644 --- a/classes/webOAuthServer.WebServer.html +++ b/classes/webOAuthServer.WebServer.html @@ -1,5 +1,5 @@ WebServer | @salesforce/core

    Handles the actions specific to the http server

    -

    Hierarchy

    • AsyncCreatable<WebServer.Options>
      • WebServer

    Constructors

    Hierarchy

    • AsyncCreatable<WebServer.Options>
      • WebServer

    Constructors

    Properties

    Constructors

    Properties

    host: string = 'localhost'
    port: number = WebOAuthServer.DEFAULT_PORT
    server: Server<typeof IncomingMessage, typeof ServerResponse>
    DEFAULT_CLIENT_SOCKET_TIMEOUT: number = 20_000

    Methods

    • sends a response redirect.

      +

    Constructors

    Properties

    host: string = 'localhost'
    port: number = WebOAuthServer.DEFAULT_PORT
    server: Server<typeof IncomingMessage, typeof ServerResponse>
    DEFAULT_CLIENT_SOCKET_TIMEOUT: number = 20_000

    Methods

    • sends a response redirect.

      Parameters

      • status: number

        the statusCode for the response.

      • url: string

        the url to redirect to.

      • response: ServerResponse<IncomingMessage>

        the response to write the redirect to.

        -

      Returns void

    • Parameters

      • response: ServerResponse<IncomingMessage>

      Returns Promise<void>

    • Preflight request:

      +

    Returns void

    • Parameters

      • response: ServerResponse<IncomingMessage>

      Returns Promise<void>

    • Parameters

      • response: ServerResponse<IncomingMessage>

      Returns Promise<void>

    • sends a response to the browser reporting an error.

      +

      Parameters

      • response: ServerResponse<IncomingMessage>

      Returns void

    • Parameters

      • response: ServerResponse<IncomingMessage>

      Returns Promise<void>

    • sends a response to the browser reporting an error.

      Parameters

      • error: Error

        the oauth error

      • response: ServerResponse<IncomingMessage>

        the HTTP response.

        -

      Returns void

    • sends a response to the browser reporting the success.

      +

    Returns void

    • sends a response to the browser reporting the success.

      Parameters

      • response: ServerResponse<IncomingMessage>

        the HTTP response.

        -

      Returns void

    • sends a response error.

      +

    Returns void

    • sends a response error.

      Parameters

      • status: number

        the statusCode for the response.

      • message: string

        the message for the http body.

      • response: ServerResponse<IncomingMessage>

        the response to write the error to.

        -

      Returns void

    • Starts the http server after checking that the port is open

      -

      Returns Promise<void>

    \ No newline at end of file +

    Returns void

    • Starts the http server after checking that the port is open

      +

      Returns Promise<void>

    \ No newline at end of file diff --git a/enums/config_config.SfConfigProperties.html b/enums/config_config.SfConfigProperties.html index 7f54ae5ab..5aed382e9 100644 --- a/enums/config_config.SfConfigProperties.html +++ b/enums/config_config.SfConfigProperties.html @@ -1,3 +1,3 @@ -SfConfigProperties | @salesforce/core

    Enumeration Members

    DISABLE_TELEMETRY +SfConfigProperties | @salesforce/core

    Enumeration Members

    Enumeration Members

    DISABLE_TELEMETRY: "disable-telemetry"

    Disables telemetry reporting

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/enums/config_config.SfdxPropertyKeys.html b/enums/config_config.SfdxPropertyKeys.html index 0c929659c..f318583c9 100644 --- a/enums/config_config.SfdxPropertyKeys.html +++ b/enums/config_config.SfdxPropertyKeys.html @@ -1,4 +1,4 @@ -SfdxPropertyKeys | @salesforce/core

    Enumeration Members

    API_VERSION +SfdxPropertyKeys | @salesforce/core

    Enumeration Members

    API_VERSION: "apiVersion"

    The api version

    Deprecated

    Replaced by OrgConfigProperties.ORG_API_VERSION in v3 https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#config

    -
    CUSTOM_ORG_METADATA_TEMPLATES: "customOrgMetadataTemplates"

    Custom templates repo or local location.

    +
    CUSTOM_ORG_METADATA_TEMPLATES: "customOrgMetadataTemplates"

    Custom templates repo or local location.

    Deprecated

    Replaced by OrgConfigProperties.ORG_CUSTOM_METADATA_TEMPLATES in v3 https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#config

    -
    DEFAULT_DEV_HUB_USERNAME: "defaultdevhubusername"

    Username associated with the default dev hub org.

    +
    DEFAULT_DEV_HUB_USERNAME: "defaultdevhubusername"

    Username associated with the default dev hub org.

    Deprecated

    Replaced by OrgConfigProperties.TARGET_DEV_HUB in v3 https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#config will remain in v3 for the foreseeable future so that sfdx-core can map between sf and sfdx config values

    -
    DEFAULT_USERNAME: "defaultusername"

    Username associate with the default org.

    +
    DEFAULT_USERNAME: "defaultusername"

    Username associate with the default org.

    Deprecated

    Replaced by OrgConfigProperties.TARGET_ORG in v3 https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#config will remain in v3 for the foreseeable future so that sfdx-core can map between sf and sfdx config values

    -
    DISABLE_TELEMETRY: "disableTelemetry"

    Disables telemetry reporting

    +
    DISABLE_TELEMETRY: "disableTelemetry"

    Disables telemetry reporting

    Deprecated

    Replaced by SfPropertyKeys.DISABLE_TELEMETRY in v3 https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#config

    -
    INSTANCE_URL: "instanceUrl"

    Deprecated

    Replaced by OrgConfigProperties.ORG_INSTANCE_URL in v3 https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#config

    -
    ISV_DEBUGGER_SID: "isvDebuggerSid"

    The sid for the debugger configuration.

    +
    INSTANCE_URL: "instanceUrl"

    Deprecated

    Replaced by OrgConfigProperties.ORG_INSTANCE_URL in v3 https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#config

    +
    ISV_DEBUGGER_SID: "isvDebuggerSid"

    The sid for the debugger configuration.

    Deprecated

    Replaced by OrgConfigProperties.ORG_ISV_DEBUGGER_SID in v3 https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#config

    -
    ISV_DEBUGGER_URL: "isvDebuggerUrl"

    The url for the debugger configuration.

    +
    ISV_DEBUGGER_URL: "isvDebuggerUrl"

    The url for the debugger configuration.

    Deprecated

    Replaced by OrgConfigProperties.ORG_ISV_DEBUGGER_URL in v3 https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#config

    -
    MAX_QUERY_LIMIT: "maxQueryLimit"

    allows users to override the 10,000 result query limit

    +
    MAX_QUERY_LIMIT: "maxQueryLimit"

    allows users to override the 10,000 result query limit

    Deprecated

    Replaced by OrgConfigProperties.ORG_MAX_QUERY_LIMIT in v3 https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#config

    -
    REST_DEPLOY: "restDeploy"

    Deprecated

    \ No newline at end of file +
    REST_DEPLOY: "restDeploy"

    Deprecated

    \ No newline at end of file diff --git a/enums/config_configAggregator.ConfigAggregator.Location.html b/enums/config_configAggregator.ConfigAggregator.Location.html index 93479f843..096acf83a 100644 --- a/enums/config_configAggregator.ConfigAggregator.Location.html +++ b/enums/config_configAggregator.ConfigAggregator.Location.html @@ -1,8 +1,8 @@ Location | @salesforce/core

    An enum of all possible locations for a config value.

    -

    Enumeration Members

    Enumeration Members

    Enumeration Members

    ENVIRONMENT: "Environment"

    Represents environment variables.

    -
    GLOBAL: "Global"

    Represents the global config.

    -
    LOCAL: "Local"

    Represents the local project config.

    -
    \ No newline at end of file +
    GLOBAL: "Global"

    Represents the global config.

    +
    LOCAL: "Local"

    Represents the local project config.

    +
    \ No newline at end of file diff --git a/enums/config_envVars.EnvironmentVariable.html b/enums/config_envVars.EnvironmentVariable.html index c60e194b4..7598ee5ac 100644 --- a/enums/config_envVars.EnvironmentVariable.html +++ b/enums/config_envVars.EnvironmentVariable.html @@ -1,4 +1,4 @@ -EnvironmentVariable | @salesforce/core

    Enumeration Members

    FORCE_OPEN_URL +EnvironmentVariable | @salesforce/core

    Enumeration Members

    FORCE_OPEN_URL: "FORCE_OPEN_URL"
    FORCE_SHOW_SPINNER: "FORCE_SHOW_SPINNER"
    FORCE_SPINNER_DELAY: "FORCE_SPINNER_DELAY"
    HTTPS_PROXY: "HTTPS_PROXY"
    HTTP_PROXY: "HTTP_PROXY"
    NODE_EXTRA_CA_CERTS: "NODE_EXTRA_CA_CERTS"
    NODE_TLS_REJECT_UNAUTHORIZED: "NODE_TLS_REJECT_UNAUTHORIZED"
    SFDX_ACCESS_TOKEN: "SFDX_ACCESS_TOKEN"
    SFDX_API_VERSION: "SFDX_API_VERSION"
    SFDX_AUDIENCE_URL: "SFDX_AUDIENCE_URL"
    SFDX_AUTOUPDATE_DISABLE: "SFDX_AUTOUPDATE_DISABLE"
    SFDX_CONTENT_TYPE: "SFDX_CONTENT_TYPE"
    SFDX_DEFAULTDEVHUBUSERNAME: "SFDX_DEFAULTDEVHUBUSERNAME"
    SFDX_DEFAULTUSERNAME: "SFDX_DEFAULTUSERNAME"
    SFDX_DISABLE_AUTOUPDATE: "SFDX_DISABLE_AUTOUPDATE"
    SFDX_DISABLE_LOG_FILE: "SFDX_DISABLE_LOG_FILE"
    SFDX_DISABLE_SOURCE_MEMBER_POLLING: "SFDX_DISABLE_SOURCE_MEMBER_POLLING"
    SFDX_DISABLE_TELEMETRY: "SFDX_DISABLE_TELEMETRY"
    SFDX_DNS_TIMEOUT: "SFDX_DNS_TIMEOUT"
    SFDX_DOMAIN_RETRY: "SFDX_DOMAIN_RETRY"
    SFDX_ENV: "SFDX_ENV"
    SFDX_IMPROVED_CODE_COVERAGE: "SFDX_IMPROVED_CODE_COVERAGE"
    SFDX_INSTALLER: "SFDX_INSTALLER"
    SFDX_INSTANCE_URL: "SFDX_INSTANCE_URL"
    SFDX_JSON_TO_STDOUT: "SFDX_JSON_TO_STDOUT"
    SFDX_LAZY_LOAD_MODULES: "SFDX_LAZY_LOAD_MODULES"
    SFDX_LOG_LEVEL: "SFDX_LOG_LEVEL"
    SFDX_LOG_ROTATION_COUNT: "SFDX_LOG_ROTATION_COUNT"
    SFDX_LOG_ROTATION_PERIOD: "SFDX_LOG_ROTATION_PERIOD"
    SFDX_MAX_QUERY_LIMIT: "SFDX_MAX_QUERY_LIMIT"
    SFDX_MDAPI_TEMP_DIR: "SFDX_MDAPI_TEMP_DIR"
    SFDX_NPM_REGISTRY: "SFDX_NPM_REGISTRY"
    SFDX_PRECOMPILE_ENABLE: "SFDX_PRECOMPILE_ENABLE"
    SFDX_PROJECT_AUTOUPDATE_DISABLE_FOR_PACKAGE_CREATE: "SFDX_PROJECT_AUTOUPDATE_DISABLE_FOR_PACKAGE_CREATE"
    SFDX_PROJECT_AUTOUPDATE_DISABLE_FOR_PACKAGE_VERSION_CREATE: "SFDX_PROJECT_AUTOUPDATE_DISABLE_FOR_PACKAGE_VERSION_CREATE"
    SFDX_REST_DEPLOY: "SFDX_REST_DEPLOY"
    SFDX_S3_HOST: "SFDX_S3_HOST"
    SFDX_SOURCE_MEMBER_POLLING_TIMEOUT: "SFDX_SOURCE_MEMBER_POLLING_TIMEOUT"
    SFDX_SOURCE_TRACKING_BATCH_SIZE: "SFDX_SOURCE_TRACKING_BATCH_SIZE"
    SFDX_UPDATE_INSTRUCTIONS: "SFDX_UPDATE_INSTRUCTIONS"
    SFDX_USE_GENERIC_UNIX_KEYCHAIN: "SFDX_USE_GENERIC_UNIX_KEYCHAIN"
    SFDX_USE_PROGRESS_BAR: "SFDX_USE_PROGRESS_BAR"
    SF_ACCESS_TOKEN: "SF_ACCESS_TOKEN"
    SF_AUDIENCE_URL: "SF_AUDIENCE_URL"
    SF_AUTOUPDATE_DISABLE: "SF_AUTOUPDATE_DISABLE"
    SF_CAPITALIZE_RECORD_TYPES: "SF_CAPITALIZE_RECORD_TYPES"
    SF_CONTENT_TYPE: "SF_CONTENT_TYPE"
    SF_DISABLE_AUTOUPDATE: "SF_DISABLE_AUTOUPDATE"
    SF_DISABLE_LOG_FILE: "SF_DISABLE_LOG_FILE"
    SF_DISABLE_SOURCE_MEMBER_POLLING: "SF_DISABLE_SOURCE_MEMBER_POLLING"
    SF_DISABLE_TELEMETRY: "SF_DISABLE_TELEMETRY"
    SF_DNS_TIMEOUT: "SF_DNS_TIMEOUT"
    SF_DOMAIN_RETRY: "SF_DOMAIN_RETRY"
    SF_ENV: "SF_ENV"
    SF_IMPROVED_CODE_COVERAGE: "SF_IMPROVED_CODE_COVERAGE"
    SF_INSTALLER: "SF_INSTALLER"
    SF_JSON_TO_STDOUT: "SF_JSON_TO_STDOUT"
    SF_LAZY_LOAD_MODULES: "SF_LAZY_LOAD_MODULES"
    SF_LOG_LEVEL: "SF_LOG_LEVEL"
    SF_LOG_ROTATION_COUNT: "SF_LOG_ROTATION_COUNT"
    SF_LOG_ROTATION_PERIOD: "SF_LOG_ROTATION_PERIOD"
    SF_MDAPI_TEMP_DIR: "SF_MDAPI_TEMP_DIR"
    SF_NPM_REGISTRY: "SF_NPM_REGISTRY"
    SF_ORG_API_VERSION: "SF_ORG_API_VERSION"
    SF_ORG_INSTANCE_URL: "SF_ORG_INSTANCE_URL"
    SF_ORG_MAX_QUERY_LIMIT: "SF_ORG_MAX_QUERY_LIMIT"
    SF_PRECOMPILE_ENABLE: "SF_PRECOMPILE_ENABLE"
    SF_PROJECT_AUTOUPDATE_DISABLE_FOR_PACKAGE_CREATE: "SF_PROJECT_AUTOUPDATE_DISABLE_FOR_PACKAGE_CREATE"
    SF_PROJECT_AUTOUPDATE_DISABLE_FOR_PACKAGE_VERSION_CREATE: "SF_PROJECT_AUTOUPDATE_DISABLE_FOR_PACKAGE_VERSION_CREATE"
    SF_S3_HOST: "SF_S3_HOST"
    SF_SOURCE_MEMBER_POLLING_TIMEOUT: "SF_SOURCE_MEMBER_POLLING_TIMEOUT"
    SF_SOURCE_TRACKING_BATCH_SIZE: "SF_SOURCE_TRACKING_BATCH_SIZE"
    SF_TARGET_DEV_HUB: "SF_TARGET_DEV_HUB"
    SF_TARGET_ORG: "SF_TARGET_ORG"
    SF_UPDATE_INSTRUCTIONS: "SF_UPDATE_INSTRUCTIONS"
    SF_USE_GENERIC_UNIX_KEYCHAIN: "SF_USE_GENERIC_UNIX_KEYCHAIN"
    SF_USE_PROGRESS_BAR: "SF_USE_PROGRESS_BAR"
    \ No newline at end of file +

    Enumeration Members

    FORCE_OPEN_URL: "FORCE_OPEN_URL"
    FORCE_SHOW_SPINNER: "FORCE_SHOW_SPINNER"
    FORCE_SPINNER_DELAY: "FORCE_SPINNER_DELAY"
    HTTPS_PROXY: "HTTPS_PROXY"
    HTTP_PROXY: "HTTP_PROXY"
    NODE_EXTRA_CA_CERTS: "NODE_EXTRA_CA_CERTS"
    NODE_TLS_REJECT_UNAUTHORIZED: "NODE_TLS_REJECT_UNAUTHORIZED"
    SFDX_ACCESS_TOKEN: "SFDX_ACCESS_TOKEN"
    SFDX_API_VERSION: "SFDX_API_VERSION"
    SFDX_AUDIENCE_URL: "SFDX_AUDIENCE_URL"
    SFDX_AUTOUPDATE_DISABLE: "SFDX_AUTOUPDATE_DISABLE"
    SFDX_CONTENT_TYPE: "SFDX_CONTENT_TYPE"
    SFDX_DEFAULTDEVHUBUSERNAME: "SFDX_DEFAULTDEVHUBUSERNAME"
    SFDX_DEFAULTUSERNAME: "SFDX_DEFAULTUSERNAME"
    SFDX_DISABLE_AUTOUPDATE: "SFDX_DISABLE_AUTOUPDATE"
    SFDX_DISABLE_LOG_FILE: "SFDX_DISABLE_LOG_FILE"
    SFDX_DISABLE_SOURCE_MEMBER_POLLING: "SFDX_DISABLE_SOURCE_MEMBER_POLLING"
    SFDX_DISABLE_TELEMETRY: "SFDX_DISABLE_TELEMETRY"
    SFDX_DNS_TIMEOUT: "SFDX_DNS_TIMEOUT"
    SFDX_DOMAIN_RETRY: "SFDX_DOMAIN_RETRY"
    SFDX_ENV: "SFDX_ENV"
    SFDX_IMPROVED_CODE_COVERAGE: "SFDX_IMPROVED_CODE_COVERAGE"
    SFDX_INSTALLER: "SFDX_INSTALLER"
    SFDX_INSTANCE_URL: "SFDX_INSTANCE_URL"
    SFDX_JSON_TO_STDOUT: "SFDX_JSON_TO_STDOUT"
    SFDX_LAZY_LOAD_MODULES: "SFDX_LAZY_LOAD_MODULES"
    SFDX_LOG_LEVEL: "SFDX_LOG_LEVEL"
    SFDX_LOG_ROTATION_COUNT: "SFDX_LOG_ROTATION_COUNT"
    SFDX_LOG_ROTATION_PERIOD: "SFDX_LOG_ROTATION_PERIOD"
    SFDX_MAX_QUERY_LIMIT: "SFDX_MAX_QUERY_LIMIT"
    SFDX_MDAPI_TEMP_DIR: "SFDX_MDAPI_TEMP_DIR"
    SFDX_NPM_REGISTRY: "SFDX_NPM_REGISTRY"
    SFDX_PRECOMPILE_ENABLE: "SFDX_PRECOMPILE_ENABLE"
    SFDX_PROJECT_AUTOUPDATE_DISABLE_FOR_PACKAGE_CREATE: "SFDX_PROJECT_AUTOUPDATE_DISABLE_FOR_PACKAGE_CREATE"
    SFDX_PROJECT_AUTOUPDATE_DISABLE_FOR_PACKAGE_VERSION_CREATE: "SFDX_PROJECT_AUTOUPDATE_DISABLE_FOR_PACKAGE_VERSION_CREATE"
    SFDX_REST_DEPLOY: "SFDX_REST_DEPLOY"
    SFDX_S3_HOST: "SFDX_S3_HOST"
    SFDX_SOURCE_MEMBER_POLLING_TIMEOUT: "SFDX_SOURCE_MEMBER_POLLING_TIMEOUT"
    SFDX_SOURCE_TRACKING_BATCH_SIZE: "SFDX_SOURCE_TRACKING_BATCH_SIZE"
    SFDX_UPDATE_INSTRUCTIONS: "SFDX_UPDATE_INSTRUCTIONS"
    SFDX_USE_GENERIC_UNIX_KEYCHAIN: "SFDX_USE_GENERIC_UNIX_KEYCHAIN"
    SFDX_USE_PROGRESS_BAR: "SFDX_USE_PROGRESS_BAR"
    SF_ACCESS_TOKEN: "SF_ACCESS_TOKEN"
    SF_AUDIENCE_URL: "SF_AUDIENCE_URL"
    SF_AUTOUPDATE_DISABLE: "SF_AUTOUPDATE_DISABLE"
    SF_CAPITALIZE_RECORD_TYPES: "SF_CAPITALIZE_RECORD_TYPES"
    SF_CONTENT_TYPE: "SF_CONTENT_TYPE"
    SF_DISABLE_AUTOUPDATE: "SF_DISABLE_AUTOUPDATE"
    SF_DISABLE_LOG_FILE: "SF_DISABLE_LOG_FILE"
    SF_DISABLE_SOURCE_MEMBER_POLLING: "SF_DISABLE_SOURCE_MEMBER_POLLING"
    SF_DISABLE_TELEMETRY: "SF_DISABLE_TELEMETRY"
    SF_DNS_TIMEOUT: "SF_DNS_TIMEOUT"
    SF_DOMAIN_RETRY: "SF_DOMAIN_RETRY"
    SF_ENV: "SF_ENV"
    SF_IMPROVED_CODE_COVERAGE: "SF_IMPROVED_CODE_COVERAGE"
    SF_INSTALLER: "SF_INSTALLER"
    SF_JSON_TO_STDOUT: "SF_JSON_TO_STDOUT"
    SF_LAZY_LOAD_MODULES: "SF_LAZY_LOAD_MODULES"
    SF_LOG_LEVEL: "SF_LOG_LEVEL"
    SF_LOG_ROTATION_COUNT: "SF_LOG_ROTATION_COUNT"
    SF_LOG_ROTATION_PERIOD: "SF_LOG_ROTATION_PERIOD"
    SF_MDAPI_TEMP_DIR: "SF_MDAPI_TEMP_DIR"
    SF_NPM_REGISTRY: "SF_NPM_REGISTRY"
    SF_ORG_API_VERSION: "SF_ORG_API_VERSION"
    SF_ORG_INSTANCE_URL: "SF_ORG_INSTANCE_URL"
    SF_ORG_MAX_QUERY_LIMIT: "SF_ORG_MAX_QUERY_LIMIT"
    SF_PRECOMPILE_ENABLE: "SF_PRECOMPILE_ENABLE"
    SF_PROJECT_AUTOUPDATE_DISABLE_FOR_PACKAGE_CREATE: "SF_PROJECT_AUTOUPDATE_DISABLE_FOR_PACKAGE_CREATE"
    SF_PROJECT_AUTOUPDATE_DISABLE_FOR_PACKAGE_VERSION_CREATE: "SF_PROJECT_AUTOUPDATE_DISABLE_FOR_PACKAGE_VERSION_CREATE"
    SF_S3_HOST: "SF_S3_HOST"
    SF_SOURCE_MEMBER_POLLING_TIMEOUT: "SF_SOURCE_MEMBER_POLLING_TIMEOUT"
    SF_SOURCE_TRACKING_BATCH_SIZE: "SF_SOURCE_TRACKING_BATCH_SIZE"
    SF_TARGET_DEV_HUB: "SF_TARGET_DEV_HUB"
    SF_TARGET_ORG: "SF_TARGET_ORG"
    SF_UPDATE_INSTRUCTIONS: "SF_UPDATE_INSTRUCTIONS"
    SF_USE_GENERIC_UNIX_KEYCHAIN: "SF_USE_GENERIC_UNIX_KEYCHAIN"
    SF_USE_PROGRESS_BAR: "SF_USE_PROGRESS_BAR"
    \ No newline at end of file diff --git a/enums/config_sandboxOrgConfig.SandboxOrgConfig.Fields.html b/enums/config_sandboxOrgConfig.SandboxOrgConfig.Fields.html index fe0e08494..a59df13d2 100644 --- a/enums/config_sandboxOrgConfig.SandboxOrgConfig.Fields.html +++ b/enums/config_sandboxOrgConfig.SandboxOrgConfig.Fields.html @@ -1,3 +1,3 @@ -Fields | @salesforce/core

    Enumeration Members

    PROD_ORG_USERNAME +Fields | @salesforce/core

    Enumeration Members

    Enumeration Members

    PROD_ORG_USERNAME: "prodOrgUsername"

    The username of the user who created the sandbox.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/enums/global.Mode.html b/enums/global.Mode.html index 77f81a852..3e7276637 100644 --- a/enums/global.Mode.html +++ b/enums/global.Mode.html @@ -1,8 +1,8 @@ Mode | @salesforce/core

    Represents an environment mode. Supports production, development, demo, and test with the default mode being production.

    To set the mode, export SFDX_ENV=<mode> in your current environment.

    -

    Enumeration Members

    Enumeration Members

    Enumeration Members

    DEMO: "demo"
    DEVELOPMENT: "development"
    PRODUCTION: "production"
    TEST: "test"
    \ No newline at end of file +

    Enumeration Members

    DEMO: "demo"
    DEVELOPMENT: "development"
    PRODUCTION: "production"
    TEST: "test"
    \ No newline at end of file diff --git a/enums/logger_logger.LoggerLevel.html b/enums/logger_logger.LoggerLevel.html index 739fb82a8..311f37bd4 100644 --- a/enums/logger_logger.LoggerLevel.html +++ b/enums/logger_logger.LoggerLevel.html @@ -1,9 +1,9 @@ LoggerLevel | @salesforce/core

    Standard Logger levels.

    See Logger Levels

    -

    Enumeration Members

    Enumeration Members

    Enumeration Members

    DEBUG: 20
    ERROR: 50
    FATAL: 60
    INFO: 30
    TRACE: 10
    WARN: 40
    \ No newline at end of file +

    Enumeration Members

    DEBUG: 20
    ERROR: 50
    FATAL: 60
    INFO: 30
    TRACE: 10
    WARN: 40
    \ No newline at end of file diff --git a/enums/org_org.Org.Fields.html b/enums/org_org.Org.Fields.html index fb286e200..1e5e91abe 100644 --- a/enums/org_org.Org.Fields.html +++ b/enums/org_org.Org.Fields.html @@ -1,5 +1,5 @@ Fields | @salesforce/core

    Org Fields.

    -

    Enumeration Members

    Enumeration Members

    ALIAS: "alias"

    The org alias.

    -
    CREATED: "created"
    CREATED_ORG_INSTANCE: "createdOrgInstance"

    The Salesforce instance the org was created on. e.g. cs42.

    -
    DEV_HUB_USERNAME: "devHubUsername"

    The username of the dev hub org that created this org. Only populated for scratch orgs.

    -
    INSTANCE_NAME: "instanceName"
    INSTANCE_URL: "instanceUrl"

    The full url of the instance the org lives on.

    -
    IS_DEV_HUB: "isDevHub"

    Is the current org a dev hub org. e.g. They have access to the ScratchOrgInfo object.

    -
    IS_SANDBOX: "isSandbox"

    Is the current org a sandbox (not a scratch org on a non-prod instance), but an actual Sandbox org). e.g. Organization has IsSandbox == true and TrialExpirationDate == null.

    -
    IS_SCRATCH: "isScratch"

    Is the current org a scratch org. e.g. Organization has IsSandbox == true and TrialExpirationDate != null.

    -
    LOGIN_URL: "loginUrl"

    The login url of the org. e.g. https://login.salesforce.com or https://test.salesforce.com.

    -
    NAME: "name"
    NAMESPACE_PREFIX: "namespacePrefix"
    ORG_ID: "orgId"

    The org ID.

    -
    SNAPSHOT: "snapshot"

    The snapshot used to create the scratch org.

    -
    STATUS: "status"

    The OrgStatus of the org.

    -
    TRACKS_SOURCE: "tracksSource"

    true: the org supports and wants source tracking +

    CREATED: "created"
    CREATED_ORG_INSTANCE: "createdOrgInstance"

    The Salesforce instance the org was created on. e.g. cs42.

    +
    DEV_HUB_USERNAME: "devHubUsername"

    The username of the dev hub org that created this org. Only populated for scratch orgs.

    +
    INSTANCE_NAME: "instanceName"
    INSTANCE_URL: "instanceUrl"

    The full url of the instance the org lives on.

    +
    IS_DEV_HUB: "isDevHub"

    Is the current org a dev hub org. e.g. They have access to the ScratchOrgInfo object.

    +
    IS_SANDBOX: "isSandbox"

    Is the current org a sandbox (not a scratch org on a non-prod instance), but an actual Sandbox org). e.g. Organization has IsSandbox == true and TrialExpirationDate == null.

    +
    IS_SCRATCH: "isScratch"

    Is the current org a scratch org. e.g. Organization has IsSandbox == true and TrialExpirationDate != null.

    +
    LOGIN_URL: "loginUrl"

    The login url of the org. e.g. https://login.salesforce.com or https://test.salesforce.com.

    +
    NAME: "name"
    NAMESPACE_PREFIX: "namespacePrefix"
    ORG_ID: "orgId"

    The org ID.

    +
    SNAPSHOT: "snapshot"

    The snapshot used to create the scratch org.

    +
    STATUS: "status"

    The OrgStatus of the org.

    +
    TRACKS_SOURCE: "tracksSource"

    true: the org supports and wants source tracking false: the org opted out of tracking or can't support it

    -
    TRIAL_EXPIRATION_DATE: "trailExpirationDate"
    \ No newline at end of file +
    TRIAL_EXPIRATION_DATE: "trailExpirationDate"
    \ No newline at end of file diff --git a/enums/org_org.Org.Status.html b/enums/org_org.Org.Status.html index 0ec8a7cce..5325c3bf0 100644 --- a/enums/org_org.Org.Status.html +++ b/enums/org_org.Org.Status.html @@ -1,10 +1,10 @@ Status | @salesforce/core

    Scratch Org status.

    -

    Enumeration Members

    Enumeration Members

    Enumeration Members

    ACTIVE: "ACTIVE"

    The scratch org is active.

    -
    EXPIRED: "EXPIRED"

    The scratch org has expired.

    -
    MISSING: "MISSING"

    The dev hub configuration is reporting an active Scratch org but the AuthInfo cannot be found.

    -
    UNKNOWN: "UNKNOWN"

    The org is a scratch Org but no dev hub is indicated.

    -
    \ No newline at end of file +
    EXPIRED: "EXPIRED"

    The scratch org has expired.

    +
    MISSING: "MISSING"

    The dev hub configuration is reporting an active Scratch org but the AuthInfo cannot be found.

    +
    UNKNOWN: "UNKNOWN"

    The org is a scratch Org but no dev hub is indicated.

    +
    \ No newline at end of file diff --git a/enums/org_org.OrgTypes.html b/enums/org_org.OrgTypes.html index c25f9dabd..62d163ba5 100644 --- a/enums/org_org.OrgTypes.html +++ b/enums/org_org.OrgTypes.html @@ -1,3 +1,3 @@ -OrgTypes | @salesforce/core

    Enumeration Members

    Sandbox +OrgTypes | @salesforce/core

    Enumeration Members

    Enumeration Members

    Sandbox: "sandbox"
    Scratch: "scratch"
    \ No newline at end of file +

    Enumeration Members

    Sandbox: "sandbox"
    Scratch: "scratch"
    \ No newline at end of file diff --git a/enums/org_org.SandboxEvents.html b/enums/org_org.SandboxEvents.html index d85226b9b..3370ceffe 100644 --- a/enums/org_org.SandboxEvents.html +++ b/enums/org_org.SandboxEvents.html @@ -1,7 +1,7 @@ -SandboxEvents | @salesforce/core

    Enumeration SandboxEvents

    Enumeration Members

    EVENT_ASYNC_RESULT +SandboxEvents | @salesforce/core

    Enumeration SandboxEvents

    Enumeration Members

    EVENT_ASYNC_RESULT: "asyncResult"
    EVENT_AUTH: "auth"
    EVENT_MULTIPLE_SBX_PROCESSES: "multipleMatchingSbxProcesses"
    EVENT_RESULT: "result"
    EVENT_RESUME: "resume"
    EVENT_STATUS: "status"
    \ No newline at end of file +

    Enumeration Members

    EVENT_ASYNC_RESULT: "asyncResult"
    EVENT_AUTH: "auth"
    EVENT_MULTIPLE_SBX_PROCESSES: "multipleMatchingSbxProcesses"
    EVENT_RESULT: "result"
    EVENT_RESUME: "resume"
    EVENT_STATUS: "status"
    \ No newline at end of file diff --git a/enums/org_orgConfigProperties.OrgConfigProperties.html b/enums/org_orgConfigProperties.OrgConfigProperties.html index 4c20cd952..217eb2c2b 100644 --- a/enums/org_orgConfigProperties.OrgConfigProperties.html +++ b/enums/org_orgConfigProperties.OrgConfigProperties.html @@ -1,4 +1,4 @@ -OrgConfigProperties | @salesforce/core

    Enumeration Members

    ORG_API_VERSION +OrgConfigProperties | @salesforce/core

    Enumeration Members

    ORG_API_VERSION: "org-api-version"

    The api version

    -
    ORG_CAPITALIZE_RECORD_TYPES: "org-capitalize-record-types"

    Capitalize record types when deploying scratch org settings

    -
    ORG_CUSTOM_METADATA_TEMPLATES: "org-custom-metadata-templates"

    Custom templates repo or local location.

    -
    ORG_INSTANCE_URL: "org-instance-url"

    The instance url of the org.

    -
    ORG_ISV_DEBUGGER_SID: "org-isv-debugger-sid"

    The sid for the debugger configuration.

    -
    ORG_ISV_DEBUGGER_URL: "org-isv-debugger-url"

    The url for the debugger configuration.

    -
    ORG_MAX_QUERY_LIMIT: "org-max-query-limit"

    Allows users to override the 10,000 result query limit.

    -
    TARGET_DEV_HUB: "target-dev-hub"

    Username associated with the default dev hub org.

    -
    TARGET_ORG: "target-org"

    Username associate with the default org.

    -
    \ No newline at end of file +
    ORG_CAPITALIZE_RECORD_TYPES: "org-capitalize-record-types"

    Capitalize record types when deploying scratch org settings

    +
    ORG_CUSTOM_METADATA_TEMPLATES: "org-custom-metadata-templates"

    Custom templates repo or local location.

    +
    ORG_INSTANCE_URL: "org-instance-url"

    The instance url of the org.

    +
    ORG_ISV_DEBUGGER_SID: "org-isv-debugger-sid"

    The sid for the debugger configuration.

    +
    ORG_ISV_DEBUGGER_URL: "org-isv-debugger-url"

    The url for the debugger configuration.

    +
    ORG_MAX_QUERY_LIMIT: "org-max-query-limit"

    Allows users to override the 10,000 result query limit.

    +
    TARGET_DEV_HUB: "target-dev-hub"

    Username associated with the default dev hub org.

    +
    TARGET_ORG: "target-org"

    Username associate with the default org.

    +
    \ No newline at end of file diff --git a/enums/org_scratchOrgSettingsGenerator.RequestStatus.html b/enums/org_scratchOrgSettingsGenerator.RequestStatus.html index ae9401d5f..4387db849 100644 --- a/enums/org_scratchOrgSettingsGenerator.RequestStatus.html +++ b/enums/org_scratchOrgSettingsGenerator.RequestStatus.html @@ -1,8 +1,8 @@ -RequestStatus | @salesforce/core

    Enumeration Members

    Canceled +RequestStatus | @salesforce/core

    Enumeration Members

    Canceled: "Canceled"
    Canceling: "Canceling"
    Failed: "Failed"
    InProgress: "InProgress"
    Pending: "Pending"
    Succeeded: "Succeeded"
    SucceededPartial: "SucceededPartial"
    \ No newline at end of file +

    Enumeration Members

    Canceled: "Canceled"
    Canceling: "Canceling"
    Failed: "Failed"
    InProgress: "InProgress"
    Pending: "Pending"
    Succeeded: "Succeeded"
    SucceededPartial: "SucceededPartial"
    \ No newline at end of file diff --git a/enums/status_streamingClient.StreamingClient.ConnectionState.html b/enums/status_streamingClient.StreamingClient.ConnectionState.html index e5ee2f51f..605578bf5 100644 --- a/enums/status_streamingClient.StreamingClient.ConnectionState.html +++ b/enums/status_streamingClient.StreamingClient.ConnectionState.html @@ -1,5 +1,5 @@ ConnectionState | @salesforce/core

    Connection state

    Enumeration Members

    Enumeration Members

    Enumeration Members

    CONNECTED: 0

    Used to indicated that the streaming client is connected.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/enums/status_streamingClient.StreamingClient.TimeoutErrorType.html b/enums/status_streamingClient.StreamingClient.TimeoutErrorType.html index f984177b8..2c46850b7 100644 --- a/enums/status_streamingClient.StreamingClient.TimeoutErrorType.html +++ b/enums/status_streamingClient.StreamingClient.TimeoutErrorType.html @@ -1,6 +1,6 @@ TimeoutErrorType | @salesforce/core

    Indicators to test error names for StreamingTimeouts

    -

    Enumeration Members

    Enumeration Members

    Enumeration Members

    HANDSHAKE: "GenericHandshakeTimeoutError"

    To indicate the error occurred on handshake

    -
    SUBSCRIBE: "GenericTimeoutError"

    To indicate the error occurred on subscribe

    -
    \ No newline at end of file +
    SUBSCRIBE: "GenericTimeoutError"

    To indicate the error occurred on subscribe

    +
    \ No newline at end of file diff --git a/enums/testSetup.StreamingMockSubscriptionCall.html b/enums/testSetup.StreamingMockSubscriptionCall.html index 1aefc90ed..3ff14e593 100644 --- a/enums/testSetup.StreamingMockSubscriptionCall.html +++ b/enums/testSetup.StreamingMockSubscriptionCall.html @@ -1,5 +1,5 @@ StreamingMockSubscriptionCall | @salesforce/core

    Enumeration StreamingMockSubscriptionCall

    A helper to determine if a subscription will use callback or errorback. Enable errback to simulate a subscription failure.

    -

    Enumeration Members

    Enumeration Members

    Enumeration Members

    CALLBACK: 0
    ERRORBACK: 1
    \ No newline at end of file +

    Enumeration Members

    CALLBACK: 0
    ERRORBACK: 1
    \ No newline at end of file diff --git a/functions/config_lwwMap.stateFromContents.html b/functions/config_lwwMap.stateFromContents.html index d6c3faa51..6ed41fcf2 100644 --- a/functions/config_lwwMap.stateFromContents.html +++ b/functions/config_lwwMap.stateFromContents.html @@ -1,4 +1,4 @@ stateFromContents | @salesforce/core
    • Type Parameters

      Parameters

      • contents: P

        object aligning with ConfigContents

      • Optional timestamp: bigint

        a bigInt that sets the timestamp. Defaults to the current time construct a LWWState from an object

        -

      Returns LWWState<P>

    \ No newline at end of file +

    Returns LWWState<P>

    \ No newline at end of file diff --git a/functions/lifecycleEvents.cloneUniqueListeners.html b/functions/lifecycleEvents.cloneUniqueListeners.html index 367761dff..64bafc6f7 100644 --- a/functions/lifecycleEvents.cloneUniqueListeners.html +++ b/functions/lifecycleEvents.cloneUniqueListeners.html @@ -1 +1 @@ -cloneUniqueListeners | @salesforce/core
    \ No newline at end of file +cloneUniqueListeners | @salesforce/core
    \ No newline at end of file diff --git a/functions/logger_cleanup.cleanup.html b/functions/logger_cleanup.cleanup.html index 77b2ce6df..0ebed3d89 100644 --- a/functions/logger_cleanup.cleanup.html +++ b/functions/logger_cleanup.cleanup.html @@ -3,4 +3,4 @@ based on CLEAN_ODDS, it could exit OR delete some old log files

    to start this without waiting, use void cleanup()

    accepts params to override the default behavior (used to cleanup huge log file during perf tests)

    -

    Parameters

    • maxMs: number = MAX_FILE_AGE_MS
    • force: boolean = false

    Returns Promise<void>

    \ No newline at end of file +

    Parameters

    • maxMs: number = MAX_FILE_AGE_MS
    • force: boolean = false

    Returns Promise<void>

    \ No newline at end of file diff --git a/functions/logger_cleanup.getOldLogFiles.html b/functions/logger_cleanup.getOldLogFiles.html index 7ad6ece0c..38e4ef7a4 100644 --- a/functions/logger_cleanup.getOldLogFiles.html +++ b/functions/logger_cleanup.getOldLogFiles.html @@ -1 +1 @@ -getOldLogFiles | @salesforce/core
    • Parameters

      • files: string[]
      • maxMs: number = MAX_FILE_AGE_MS

      Returns string[]

    \ No newline at end of file +getOldLogFiles | @salesforce/core
    • Parameters

      • files: string[]
      • maxMs: number = MAX_FILE_AGE_MS

      Returns string[]

    \ No newline at end of file diff --git a/functions/logger_filters.filterSecrets.html b/functions/logger_filters.filterSecrets.html index ff21162db..3753ebe6d 100644 --- a/functions/logger_filters.filterSecrets.html +++ b/functions/logger_filters.filterSecrets.html @@ -1,2 +1,2 @@ filterSecrets | @salesforce/core
    • Parameters

      • Rest ...args: unknown[]

        you *probably are passing this an object, but it can handle any type

        -

      Returns unknown

    \ No newline at end of file +

    Returns unknown

    \ No newline at end of file diff --git a/functions/logger_logger.computeLevel.html b/functions/logger_logger.computeLevel.html index 9304960d7..8267df3b5 100644 --- a/functions/logger_logger.computeLevel.html +++ b/functions/logger_logger.computeLevel.html @@ -1 +1 @@ -computeLevel | @salesforce/core
    • Parameters

      • Optional optionsLevel: string | number

      Returns string

    \ No newline at end of file +computeLevel | @salesforce/core
    • Parameters

      • Optional optionsLevel: string | number

      Returns string

    \ No newline at end of file diff --git a/functions/logger_transformStream.default.html b/functions/logger_transformStream.default.html index 5cfdcc101..739348e42 100644 --- a/functions/logger_transformStream.default.html +++ b/functions/logger_transformStream.default.html @@ -1 +1 @@ -default | @salesforce/core
    \ No newline at end of file +default | @salesforce/core
    \ No newline at end of file diff --git a/functions/messageTransformer.messageTransformer.html b/functions/messageTransformer.messageTransformer.html index 892aaa375..0e60ad174 100644 --- a/functions/messageTransformer.messageTransformer.html +++ b/functions/messageTransformer.messageTransformer.html @@ -1,2 +1,2 @@ messageTransformer | @salesforce/core
    • Experimental

      transforms messages references from dynamic run-time to static compile-time values

      -

      Returns TransformerFactory<SourceFile>

    \ No newline at end of file +

    Returns TransformerFactory<SourceFile>

    \ No newline at end of file diff --git a/functions/org_org.sandboxIsResumable.html b/functions/org_org.sandboxIsResumable.html index 523a28cd1..1aa1394c6 100644 --- a/functions/org_org.sandboxIsResumable.html +++ b/functions/org_org.sandboxIsResumable.html @@ -1 +1 @@ -sandboxIsResumable | @salesforce/core
    • Parameters

      • value: string

      Returns boolean

    \ No newline at end of file +sandboxIsResumable | @salesforce/core
    • Parameters

      • value: string

      Returns boolean

    \ No newline at end of file diff --git a/functions/org_scratchOrgCreate.scratchOrgCreate.html b/functions/org_scratchOrgCreate.scratchOrgCreate.html index e20f35f4d..bddaa2b02 100644 --- a/functions/org_scratchOrgCreate.scratchOrgCreate.html +++ b/functions/org_scratchOrgCreate.scratchOrgCreate.html @@ -1 +1 @@ -scratchOrgCreate | @salesforce/core
    \ No newline at end of file +scratchOrgCreate | @salesforce/core
    \ No newline at end of file diff --git a/functions/org_scratchOrgCreate.scratchOrgResume.html b/functions/org_scratchOrgCreate.scratchOrgResume.html index a515a9bc7..20dcc6372 100644 --- a/functions/org_scratchOrgCreate.scratchOrgResume.html +++ b/functions/org_scratchOrgCreate.scratchOrgResume.html @@ -1 +1 @@ -scratchOrgResume | @salesforce/core
    \ No newline at end of file +scratchOrgResume | @salesforce/core
    \ No newline at end of file diff --git a/functions/org_scratchOrgErrorCodes.checkScratchOrgInfoForErrors.html b/functions/org_scratchOrgErrorCodes.checkScratchOrgInfoForErrors.html index fe8674cc7..208f86ee5 100644 --- a/functions/org_scratchOrgErrorCodes.checkScratchOrgInfoForErrors.html +++ b/functions/org_scratchOrgErrorCodes.checkScratchOrgInfoForErrors.html @@ -1 +1 @@ -checkScratchOrgInfoForErrors | @salesforce/core
    \ No newline at end of file +checkScratchOrgInfoForErrors | @salesforce/core
    \ No newline at end of file diff --git a/functions/org_scratchOrgErrorCodes.validateScratchOrgInfoForResume.html b/functions/org_scratchOrgErrorCodes.validateScratchOrgInfoForResume.html index 7af31ac3d..23c26d8b8 100644 --- a/functions/org_scratchOrgErrorCodes.validateScratchOrgInfoForResume.html +++ b/functions/org_scratchOrgErrorCodes.validateScratchOrgInfoForResume.html @@ -1 +1 @@ -validateScratchOrgInfoForResume | @salesforce/core
    \ No newline at end of file +validateScratchOrgInfoForResume | @salesforce/core
    \ No newline at end of file diff --git a/functions/org_scratchOrgInfoApi.authorizeScratchOrg.html b/functions/org_scratchOrgInfoApi.authorizeScratchOrg.html index 6c7d1767e..e93986cb7 100644 --- a/functions/org_scratchOrgInfoApi.authorizeScratchOrg.html +++ b/functions/org_scratchOrgInfoApi.authorizeScratchOrg.html @@ -2,6 +2,6 @@

    scratchOrgInfoComplete - The completed ScratchOrgInfo which should contain an access token. hubOrg - the environment hub org clientSecret - The OAuth client secret. May be null for JWT OAuth flow. -signupTargetLoginUrlConfig - Login url +signupTargetLoginUrl - Login url override retry - auth retry attempts

    -

    Parameters

    • options: {
          clientSecret?: string;
          hubOrg: Org;
          retry?: number;
          scratchOrgInfoComplete: ScratchOrgInfo;
          signupTargetLoginUrlConfig?: string;
      }
      • Optional clientSecret?: string
      • hubOrg: Org
      • Optional retry?: number
      • scratchOrgInfoComplete: ScratchOrgInfo
      • Optional signupTargetLoginUrlConfig?: string

    Returns Promise<AuthInfo>

    \ No newline at end of file +

    Parameters

    • options: {
          clientSecret?: string;
          hubOrg: Org;
          retry?: number;
          scratchOrgInfoComplete: ScratchOrgInfo;
          signupTargetLoginUrl?: string;
      }
      • Optional clientSecret?: string
      • hubOrg: Org
      • Optional retry?: number
      • scratchOrgInfoComplete: ScratchOrgInfo
      • Optional signupTargetLoginUrl?: string

    Returns Promise<AuthInfo>

    \ No newline at end of file diff --git a/functions/org_scratchOrgInfoApi.deploySettings.html b/functions/org_scratchOrgInfoApi.deploySettings.html index d57c0019b..faf0aec46 100644 --- a/functions/org_scratchOrgInfoApi.deploySettings.html +++ b/functions/org_scratchOrgInfoApi.deploySettings.html @@ -2,4 +2,4 @@

    Parameters

    • scratchOrg: Org

      an instance of the Org class

    • orgSettings: default

      an instance of the SettingsGenerator class

    • apiVersion: string

      the api version (used when created the package.xml)

      -
    • timeout: Duration = ...

    Returns Promise<void>

    \ No newline at end of file +
  • timeout: Duration = ...
  • Returns Promise<void>

    \ No newline at end of file diff --git a/functions/org_scratchOrgInfoApi.pollForScratchOrgInfo.html b/functions/org_scratchOrgInfoApi.pollForScratchOrgInfo.html index 023518982..53e9a9d61 100644 --- a/functions/org_scratchOrgInfoApi.pollForScratchOrgInfo.html +++ b/functions/org_scratchOrgInfoApi.pollForScratchOrgInfo.html @@ -1,4 +1,4 @@ pollForScratchOrgInfo | @salesforce/core
    • This retrieves the ScratchOrgInfo, polling until the status is Active or Error

      Parameters

      • hubOrg: Org
      • scratchOrgInfoId: string

        the id of the scratchOrgInfo that we are retrieving

      • timeout: Duration = ...

        A Duration object

        -

      Returns Promise<ScratchOrgInfo>

    \ No newline at end of file +

    Returns Promise<ScratchOrgInfo>

    \ No newline at end of file diff --git a/functions/org_scratchOrgInfoApi.queryScratchOrgInfo.html b/functions/org_scratchOrgInfoApi.queryScratchOrgInfo.html index a2abf86a2..dfd642c22 100644 --- a/functions/org_scratchOrgInfoApi.queryScratchOrgInfo.html +++ b/functions/org_scratchOrgInfoApi.queryScratchOrgInfo.html @@ -1,4 +1,4 @@ queryScratchOrgInfo | @salesforce/core
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/org_scratchOrgInfoApi.requestScratchOrgCreation.html b/functions/org_scratchOrgInfoApi.requestScratchOrgCreation.html index 32ed6500c..9e271c008 100644 --- a/functions/org_scratchOrgInfoApi.requestScratchOrgCreation.html +++ b/functions/org_scratchOrgInfoApi.requestScratchOrgCreation.html @@ -2,4 +2,4 @@

    Parameters

    • hubOrg: Org

      the environment hub org

    • scratchOrgRequest: ScratchOrgInfo

      An object containing the fields of the ScratchOrgInfo

    • settings: default

      An object containing org settings

      -

    Returns Promise<SaveResult>

    \ No newline at end of file +

    Returns Promise<SaveResult>

    \ No newline at end of file diff --git a/functions/org_scratchOrgInfoApi.resolveUrl.html b/functions/org_scratchOrgInfoApi.resolveUrl.html index ac07d8d96..0fc2fec4a 100644 --- a/functions/org_scratchOrgInfoApi.resolveUrl.html +++ b/functions/org_scratchOrgInfoApi.resolveUrl.html @@ -1,4 +1,4 @@ resolveUrl | @salesforce/core
    • Makes sure the scratch org's instanceUrl is resolvable (that is, DNS is ready)

      Parameters

      • scratchOrgAuthInfo: AuthInfo

        an AuthInfo class from the scratch org

      Returns Promise<AuthInfo>

      AuthInfo

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/org_scratchOrgInfoApi.updateRevisionCounterToZero.html b/functions/org_scratchOrgInfoApi.updateRevisionCounterToZero.html index c58915d48..2502ac547 100644 --- a/functions/org_scratchOrgInfoApi.updateRevisionCounterToZero.html +++ b/functions/org_scratchOrgInfoApi.updateRevisionCounterToZero.html @@ -1 +1 @@ -updateRevisionCounterToZero | @salesforce/core
    \ No newline at end of file +updateRevisionCounterToZero | @salesforce/core
    \ No newline at end of file diff --git a/functions/org_scratchOrgInfoGenerator.generateScratchOrgInfo.html b/functions/org_scratchOrgInfoGenerator.generateScratchOrgInfo.html index a41bd1fd0..27e5696e3 100644 --- a/functions/org_scratchOrgInfoGenerator.generateScratchOrgInfo.html +++ b/functions/org_scratchOrgInfoGenerator.generateScratchOrgInfo.html @@ -1,2 +1,2 @@ generateScratchOrgInfo | @salesforce/core
    \ No newline at end of file +

    Parameters

    • __namedParameters: {
          hubOrg: Org;
          ignoreAncestorIds?: boolean;
          nonamespace?: boolean;
          scratchOrgInfoPayload: ScratchOrgInfoPayload;
      }
      • hubOrg: Org
      • Optional ignoreAncestorIds?: boolean
      • Optional nonamespace?: boolean
      • scratchOrgInfoPayload: ScratchOrgInfoPayload

    Returns Promise<ScratchOrgInfoPayload>

    \ No newline at end of file diff --git a/functions/org_scratchOrgInfoGenerator.getAncestorIds.html b/functions/org_scratchOrgInfoGenerator.getAncestorIds.html index 63dfe357a..cc0f43c5c 100644 --- a/functions/org_scratchOrgInfoGenerator.getAncestorIds.html +++ b/functions/org_scratchOrgInfoGenerator.getAncestorIds.html @@ -2,4 +2,4 @@

    Parameters

    Returns Promise<string>

    \ No newline at end of file +

    Returns Promise<string>

    \ No newline at end of file diff --git a/functions/org_scratchOrgInfoGenerator.getScratchOrgInfoPayload.html b/functions/org_scratchOrgInfoGenerator.getScratchOrgInfoPayload.html index ec36a3bbd..89c3c6a09 100644 --- a/functions/org_scratchOrgInfoGenerator.getScratchOrgInfoPayload.html +++ b/functions/org_scratchOrgInfoGenerator.getScratchOrgInfoPayload.html @@ -9,4 +9,4 @@

    Parameters

    • options: {
          connectedAppConsumerKey?: string;
          definitionfile?: string;
          definitionjson?: string;
          durationDays: number;
          noancestors?: boolean;
          nonamespace?: boolean;
          orgConfig?: Record<string, unknown>;
      }
      • Optional connectedAppConsumerKey?: string
      • Optional definitionfile?: string
      • Optional definitionjson?: string
      • durationDays: number
      • Optional noancestors?: boolean
      • Optional nonamespace?: boolean
      • Optional orgConfig?: Record<string, unknown>

    Returns Promise<{
        ignoreAncestorIds: boolean;
        scratchOrgInfoPayload: ScratchOrgInfoPayload;
        warnings: string[];
    }>

    scratchOrgInfoPayload: ScratchOrgInfoPayload; ignoreAncestorIds: boolean; warnings: string[];

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/org_scratchOrgLifecycleEvents.emit.html b/functions/org_scratchOrgLifecycleEvents.emit.html index 544d80d99..0401c5597 100644 --- a/functions/org_scratchOrgLifecycleEvents.emit.html +++ b/functions/org_scratchOrgLifecycleEvents.emit.html @@ -1 +1 @@ -emit | @salesforce/core
    \ No newline at end of file +emit | @salesforce/core
    \ No newline at end of file diff --git a/functions/org_scratchOrgLifecycleEvents.emitPostOrgCreate.html b/functions/org_scratchOrgLifecycleEvents.emitPostOrgCreate.html index 99cd59c63..112e03be4 100644 --- a/functions/org_scratchOrgLifecycleEvents.emitPostOrgCreate.html +++ b/functions/org_scratchOrgLifecycleEvents.emitPostOrgCreate.html @@ -1 +1 @@ -emitPostOrgCreate | @salesforce/core
    \ No newline at end of file +emitPostOrgCreate | @salesforce/core
    \ No newline at end of file diff --git a/functions/org_scratchOrgSettingsGenerator.createObjectFileContent.html b/functions/org_scratchOrgSettingsGenerator.createObjectFileContent.html index 1681c9d16..fca25632a 100644 --- a/functions/org_scratchOrgSettingsGenerator.createObjectFileContent.html +++ b/functions/org_scratchOrgSettingsGenerator.createObjectFileContent.html @@ -1 +1 @@ -createObjectFileContent | @salesforce/core
    • Parameters

      • __namedParameters: {
            allBusinessProcesses?: string[];
            allRecordTypes?: string[];
            apiVersion: string;
            objectSettingsData?: {
                [objectName: string]: ObjectSetting;
            };
            settingData?: Record<string, unknown>;
        }
        • Optional allBusinessProcesses?: string[]
        • Optional allRecordTypes?: string[]
        • apiVersion: string
        • Optional objectSettingsData?: {
              [objectName: string]: ObjectSetting;
          }
        • Optional settingData?: Record<string, unknown>

      Returns PackageFile

    \ No newline at end of file +createObjectFileContent | @salesforce/core
    • Parameters

      • __namedParameters: {
            allBusinessProcesses?: string[];
            allRecordTypes?: string[];
            apiVersion: string;
            objectSettingsData?: {
                [objectName: string]: ObjectSetting;
            };
            settingData?: Record<string, unknown>;
        }
        • Optional allBusinessProcesses?: string[]
        • Optional allRecordTypes?: string[]
        • apiVersion: string
        • Optional objectSettingsData?: {
              [objectName: string]: ObjectSetting;
          }
        • Optional settingData?: Record<string, unknown>

      Returns PackageFile

    \ No newline at end of file diff --git a/functions/org_scratchOrgSettingsGenerator.createRecordTypeAndBusinessProcessFileContent.html b/functions/org_scratchOrgSettingsGenerator.createRecordTypeAndBusinessProcessFileContent.html index 786b4f0f3..d23ee858b 100644 --- a/functions/org_scratchOrgSettingsGenerator.createRecordTypeAndBusinessProcessFileContent.html +++ b/functions/org_scratchOrgSettingsGenerator.createRecordTypeAndBusinessProcessFileContent.html @@ -1 +1 @@ -createRecordTypeAndBusinessProcessFileContent | @salesforce/core
    • Parameters

      • objectName: string
      • json: Record<string, unknown>
      • allRecordTypes: string[]
      • allBusinessProcesses: string[]
      • capitalizeRecordTypes: boolean

      Returns JsonMap

    \ No newline at end of file +createRecordTypeAndBusinessProcessFileContent | @salesforce/core
    • Parameters

      • objectName: string
      • json: Record<string, unknown>
      • allRecordTypes: string[]
      • allBusinessProcesses: string[]
      • capitalizeRecordTypes: boolean

      Returns JsonMap

    \ No newline at end of file diff --git a/functions/sfProject.isNamedPackagingDirectory.html b/functions/sfProject.isNamedPackagingDirectory.html index 795979d9b..226446a9a 100644 --- a/functions/sfProject.isNamedPackagingDirectory.html +++ b/functions/sfProject.isNamedPackagingDirectory.html @@ -1,2 +1,2 @@ isNamedPackagingDirectory | @salesforce/core

    Function isNamedPackagingDirectory

    • differentiate between the Base PackageDir (path, maybe default) and the Packaging version (package and maybe a LOT of other fields) by whether is has the package property

      -

      Parameters

      Returns packageDir is NamedPackagingDir

    \ No newline at end of file +

    Parameters

    Returns packageDir is NamedPackagingDir

    \ No newline at end of file diff --git a/functions/sfProject.isPackagingDirectory.html b/functions/sfProject.isPackagingDirectory.html index 8a23d55fc..92f7ede84 100644 --- a/functions/sfProject.isPackagingDirectory.html +++ b/functions/sfProject.isPackagingDirectory.html @@ -1,2 +1,2 @@ isPackagingDirectory | @salesforce/core
    • differentiate between the Base PackageDir (path, maybe default) and the Packaging version (package and maybe a LOT of other fields) by whether is has the package property

      -

      Parameters

      • packageDir: PackageDir

      Returns packageDir is PackagePackageDir

    \ No newline at end of file +

    Parameters

    • packageDir: PackageDir

    Returns packageDir is PackagePackageDir

    \ No newline at end of file diff --git a/functions/stateAggregator_accessors_aliasAccessor.getFileLocation.html b/functions/stateAggregator_accessors_aliasAccessor.getFileLocation.html index ee10206bc..0384236d9 100644 --- a/functions/stateAggregator_accessors_aliasAccessor.getFileLocation.html +++ b/functions/stateAggregator_accessors_aliasAccessor.getFileLocation.html @@ -1 +1 @@ -getFileLocation | @salesforce/core
    \ No newline at end of file +getFileLocation | @salesforce/core
    \ No newline at end of file diff --git a/functions/testSetup.instantiateContext.html b/functions/testSetup.instantiateContext.html index 3f440267b..6c1e8a295 100644 --- a/functions/testSetup.instantiateContext.html +++ b/functions/testSetup.instantiateContext.html @@ -4,4 +4,4 @@

    Note: Call stubContext in your beforeEach to have clean stubs of @salesforce/core every test run.

    Parameters

    • Optional sinon: SinonStatic

    Returns TestContext

    Example

    const $$ = instantiateContext();

    beforeEach(() => {
    $$.init()
    });

    afterEach(() => {
    $$.restore();
    });
    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/testSetup.restoreContext.html b/functions/testSetup.restoreContext.html index fb477d3b9..b7e00ee59 100644 --- a/functions/testSetup.restoreContext.html +++ b/functions/testSetup.restoreContext.html @@ -3,4 +3,4 @@ want to isolate it to a single describe.

    Parameters

    Returns void

    Example

    const $$ = instantiateContext();

    beforeEach(() => {
    $$.init()
    });

    afterEach(() => {
    $$.restore();
    });
    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/testSetup.shouldThrow.html b/functions/testSetup.shouldThrow.html index 179bef14a..456d44403 100644 --- a/functions/testSetup.shouldThrow.html +++ b/functions/testSetup.shouldThrow.html @@ -2,4 +2,4 @@
     try {
    await call()
    assert.fail("this should never happen");
    } catch (e) {
    ...
    }

    Just do this

    try {
    await shouldThrow(call()); // If this succeeds unexpectedResultError is thrown.
    } catch(e) {
    ...
    }

    Parameters

    • f: Promise<unknown>

      The async function that is expected to throw.

      -
    • Optional message: string

    Returns Promise<never>

    \ No newline at end of file +
  • Optional message: string
  • Returns Promise<never>

    \ No newline at end of file diff --git a/functions/testSetup.shouldThrowSync.html b/functions/testSetup.shouldThrowSync.html index b213e3a9f..2bc12098b 100644 --- a/functions/testSetup.shouldThrowSync.html +++ b/functions/testSetup.shouldThrowSync.html @@ -2,4 +2,4 @@
     try {
    call()
    assert.fail("this should never happen");
    } catch (e) {
    ...
    }

    Just do this

    try {
    shouldThrowSync(call); // If this succeeds unexpectedResultError is thrown.
    } catch(e) {
    ...
    }

    Parameters

    • f: (() => unknown)

      The function that is expected to throw.

      -
        • (): unknown
        • Returns unknown

    • Optional message: string

    Returns never

    \ No newline at end of file +
      • (): unknown
      • Returns unknown

  • Optional message: string
  • Returns never

    \ No newline at end of file diff --git a/functions/testSetup.stubContext.html b/functions/testSetup.stubContext.html index 104907268..c3a0aec6f 100644 --- a/functions/testSetup.stubContext.html +++ b/functions/testSetup.stubContext.html @@ -6,4 +6,4 @@

    Note: Always call restoreContext in your afterEach.

    Parameters

    Returns Record<string, SinonStub<any[], any>>

    Example

    const $$ = instantiateContext();

    beforeEach(() => {
    $$.init()
    });

    afterEach(() => {
    $$.restore();
    });
    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/util_fileLocking.lockInit.html b/functions/util_fileLocking.lockInit.html index a783d857d..1eea70191 100644 --- a/functions/util_fileLocking.lockInit.html +++ b/functions/util_fileLocking.lockInit.html @@ -5,4 +5,4 @@
  • writeAndUnlock: a function that takes the data to write and writes it to the file, then unlocks the file whether write succeeded or not
  • unlock: a function that unlocks the file (in case you don't end up calling writeAndUnlock)
  • -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/util_fileLocking.lockInitSync.html b/functions/util_fileLocking.lockInitSync.html index 3ebbe7d76..06d97ebe9 100644 --- a/functions/util_fileLocking.lockInitSync.html +++ b/functions/util_fileLocking.lockInitSync.html @@ -1,3 +1,3 @@ lockInitSync | @salesforce/core
    • prefer async lockInit. See its documentation for details.

      -

      Parameters

      • filePath: string

      Returns LockInitSyncResponse

    \ No newline at end of file +

    Parameters

    • filePath: string

    Returns LockInitSyncResponse

    \ No newline at end of file diff --git a/functions/util_fileLocking.pollUntilUnlock.html b/functions/util_fileLocking.pollUntilUnlock.html index 274685bdb..04c04e148 100644 --- a/functions/util_fileLocking.pollUntilUnlock.html +++ b/functions/util_fileLocking.pollUntilUnlock.html @@ -1,3 +1,3 @@ pollUntilUnlock | @salesforce/core
    • Poll until the file is unlocked.

      Parameters

      • filePath: string

        file path to check

        -

      Returns Promise<void>

    \ No newline at end of file +

    Returns Promise<void>

    \ No newline at end of file diff --git a/functions/util_fileLocking.pollUntilUnlockSync.html b/functions/util_fileLocking.pollUntilUnlockSync.html index 9c9061d32..e5ff45228 100644 --- a/functions/util_fileLocking.pollUntilUnlockSync.html +++ b/functions/util_fileLocking.pollUntilUnlockSync.html @@ -1 +1 @@ -pollUntilUnlockSync | @salesforce/core
    \ No newline at end of file +pollUntilUnlockSync | @salesforce/core
    \ No newline at end of file diff --git a/functions/util_findSuggestion.findSuggestion.html b/functions/util_findSuggestion.findSuggestion.html index 28db63568..c5f00937c 100644 --- a/functions/util_findSuggestion.findSuggestion.html +++ b/functions/util_findSuggestion.findSuggestion.html @@ -1,4 +1,4 @@ findSuggestion | @salesforce/core
    • From the haystack, will find the closest value to the needle

      Parameters

      • needle: string

        what the user provided - find results similar to this

      • haystack: string[]

        possible results to search against

        -

      Returns string

    \ No newline at end of file +

    Returns string

    \ No newline at end of file diff --git a/functions/util_findUppercaseKeys.ensureNoUppercaseKeys.html b/functions/util_findUppercaseKeys.ensureNoUppercaseKeys.html index d854d4371..0dee8f823 100644 --- a/functions/util_findUppercaseKeys.ensureNoUppercaseKeys.html +++ b/functions/util_findUppercaseKeys.ensureNoUppercaseKeys.html @@ -1,2 +1,2 @@ ensureNoUppercaseKeys | @salesforce/core
    • will throw on any upperCase unless they are present in the allowList. Recursively searches the object, returning valid keys

      -

      Parameters

      • path: string

      Returns ((allowList?) => ((data) => string[]))

        • (allowList?): ((data) => string[])
        • Parameters

          • allowList: string[] = []

          Returns ((data) => string[])

            • (data): string[]
            • Parameters

              • data: JsonMap

              Returns string[]

    \ No newline at end of file +

    Parameters

    • path: string

    Returns ((allowList?) => ((data) => string[]))

      • (allowList?): ((data) => string[])
      • Parameters

        • allowList: string[] = []

        Returns ((data) => string[])

          • (data): string[]
          • Parameters

            • data: JsonMap

            Returns string[]

    \ No newline at end of file diff --git a/functions/util_getJwtAudienceUrl.getJwtAudienceUrl.html b/functions/util_getJwtAudienceUrl.getJwtAudienceUrl.html index 56a989caf..4c914e430 100644 --- a/functions/util_getJwtAudienceUrl.getJwtAudienceUrl.html +++ b/functions/util_getJwtAudienceUrl.getJwtAudienceUrl.html @@ -1 +1 @@ -getJwtAudienceUrl | @salesforce/core
    • Parameters

      • options: OAuth2Config & {
            createdOrgInstance?: string;
        }

      Returns Promise<string>

    \ No newline at end of file +getJwtAudienceUrl | @salesforce/core
    • Parameters

      • options: OAuth2Config & {
            createdOrgInstance?: string;
        }

      Returns Promise<string>

    \ No newline at end of file diff --git a/functions/util_mapKeys.default.html b/functions/util_mapKeys.default.html index 6555ee09b..021e2e9f7 100644 --- a/functions/util_mapKeys.default.html +++ b/functions/util_mapKeys.default.html @@ -7,4 +7,4 @@

    Returns Record<string, unknown>

    • the object with the converted keys
    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/util_sfdc.matchesAccessToken.html b/functions/util_sfdc.matchesAccessToken.html index 7fee84d00..59b9ce5db 100644 --- a/functions/util_sfdc.matchesAccessToken.html +++ b/functions/util_sfdc.matchesAccessToken.html @@ -1,2 +1,2 @@ matchesAccessToken | @salesforce/core
    • Tests whether a given string is an access token

      -

      Parameters

      • value: string

      Returns boolean

    \ No newline at end of file +

    Parameters

    • value: string

    Returns boolean

    \ No newline at end of file diff --git a/functions/util_sfdc.trimTo15.html b/functions/util_sfdc.trimTo15.html index bd3f9c778..aa35759da 100644 --- a/functions/util_sfdc.trimTo15.html +++ b/functions/util_sfdc.trimTo15.html @@ -1,3 +1,3 @@ trimTo15 | @salesforce/core
    • Converts an 18 character Salesforce ID to 15 characters.

      Parameters

      • id: string

        The id to convert.

        -

      Returns string

    • Parameters

      • Optional id: undefined

      Returns undefined

    • Parameters

      • id: undefined | string

      Returns string | undefined

    \ No newline at end of file +

    Returns string

  • Parameters

    • Optional id: undefined

    Returns undefined

  • Parameters

    • id: undefined | string

    Returns string | undefined

  • \ No newline at end of file diff --git a/functions/util_sfdc.validateApiVersion.html b/functions/util_sfdc.validateApiVersion.html index 924deb73e..5aeba1074 100644 --- a/functions/util_sfdc.validateApiVersion.html +++ b/functions/util_sfdc.validateApiVersion.html @@ -1,3 +1,3 @@ validateApiVersion | @salesforce/core
    • Tests whether an API version matches the format i.0.

      Parameters

      • value: string

        The API version as a string.

        -

      Returns boolean

    \ No newline at end of file +

    Returns boolean

    \ No newline at end of file diff --git a/functions/util_sfdc.validateEmail.html b/functions/util_sfdc.validateEmail.html index dae297b0c..2b54d9b0c 100644 --- a/functions/util_sfdc.validateEmail.html +++ b/functions/util_sfdc.validateEmail.html @@ -1,3 +1,3 @@ validateEmail | @salesforce/core
    • Tests whether an email matches the format me@my.org

      Parameters

      • value: string

        The email as a string.

        -

      Returns boolean

    \ No newline at end of file +

    Returns boolean

    \ No newline at end of file diff --git a/functions/util_sfdc.validatePathDoesNotContainInvalidChars.html b/functions/util_sfdc.validatePathDoesNotContainInvalidChars.html index 43922028b..a4d080580 100644 --- a/functions/util_sfdc.validatePathDoesNotContainInvalidChars.html +++ b/functions/util_sfdc.validatePathDoesNotContainInvalidChars.html @@ -1,3 +1,3 @@ validatePathDoesNotContainInvalidChars | @salesforce/core

    Function validatePathDoesNotContainInvalidChars

    • Tests whether a path is in the correct format; the value doesn't include the characters "[", "]", "?", "<", ">", "?", "|"

      Parameters

      • value: string

        The path as a string.

        -

      Returns boolean

    \ No newline at end of file +

    Returns boolean

    \ No newline at end of file diff --git a/functions/util_sfdc.validateSalesforceId.html b/functions/util_sfdc.validateSalesforceId.html index 6755863d4..cd8087903 100644 --- a/functions/util_sfdc.validateSalesforceId.html +++ b/functions/util_sfdc.validateSalesforceId.html @@ -1,3 +1,3 @@ validateSalesforceId | @salesforce/core
    • Tests whether a Salesforce ID is in the correct format, a 15- or 18-character length string with only letters and numbers

      Parameters

      • value: string

        The ID as a string.

        -

      Returns boolean

    \ No newline at end of file +

    Returns boolean

    \ No newline at end of file diff --git a/functions/util_sfdcUrl.getLoginAudienceCombos.html b/functions/util_sfdcUrl.getLoginAudienceCombos.html index cecc64763..913df0acb 100644 --- a/functions/util_sfdcUrl.getLoginAudienceCombos.html +++ b/functions/util_sfdcUrl.getLoginAudienceCombos.html @@ -1 +1 @@ -getLoginAudienceCombos | @salesforce/core
    • Parameters

      • audienceUrl: string
      • loginUrl: string

      Returns [string, string][]

    \ No newline at end of file +getLoginAudienceCombos | @salesforce/core
    • Parameters

      • audienceUrl: string
      • loginUrl: string

      Returns [string, string][]

    \ No newline at end of file diff --git a/functions/util_time.nowBigInt.html b/functions/util_time.nowBigInt.html index 11dad1745..a95bf6412 100644 --- a/functions/util_time.nowBigInt.html +++ b/functions/util_time.nowBigInt.html @@ -1 +1 @@ -nowBigInt | @salesforce/core
    \ No newline at end of file +nowBigInt | @salesforce/core
    \ No newline at end of file diff --git a/functions/util_uniqid.uniqid.html b/functions/util_uniqid.uniqid.html index c5ee20489..a38b07739 100644 --- a/functions/util_uniqid.uniqid.html +++ b/functions/util_uniqid.uniqid.html @@ -6,4 +6,4 @@
  • template: a template string.
  • length: the length of the unique id as presented in hexadecimal.
  • -
    • Optional length?: number
    • Optional template?: string

    Returns string

    \ No newline at end of file +
    • Optional length?: number
    • Optional template?: string

    Returns string

    \ No newline at end of file diff --git a/functions/util_unwrapArray.unwrapArray.html b/functions/util_unwrapArray.unwrapArray.html index d0b0a2eb1..6060d63cd 100644 --- a/functions/util_unwrapArray.unwrapArray.html +++ b/functions/util_unwrapArray.unwrapArray.html @@ -1 +1 @@ -unwrapArray | @salesforce/core
    \ No newline at end of file +unwrapArray | @salesforce/core
    \ No newline at end of file diff --git a/interfaces/org_connection.Tooling.html b/interfaces/org_connection.Tooling.html index a7be04f67..4ee905b51 100644 --- a/interfaces/org_connection.Tooling.html +++ b/interfaces/org_connection.Tooling.html @@ -1,2 +1,2 @@ -Tooling | @salesforce/core
    interface Tooling<S> {
        _logger: any;
    }

    Type Parameters

    • S extends Schema = Schema

    Hierarchy

    • Tooling<S>
      • Tooling

    Properties

    Properties

    _logger: any
    \ No newline at end of file +Tooling | @salesforce/core
    interface Tooling<S> {
        _logger: any;
    }

    Type Parameters

    • S extends Schema = Schema

    Hierarchy

    • Tooling<S>
      • Tooling

    Properties

    Properties

    _logger: any
    \ No newline at end of file diff --git a/interfaces/org_scratchOrgInfoApi.JsForceError.html b/interfaces/org_scratchOrgInfoApi.JsForceError.html index 308804f9d..f9d6c798b 100644 --- a/interfaces/org_scratchOrgInfoApi.JsForceError.html +++ b/interfaces/org_scratchOrgInfoApi.JsForceError.html @@ -1,3 +1,3 @@ -JsForceError | @salesforce/core
    interface JsForceError {
        errorCode: string;
        fields: string[];
    }

    Hierarchy

    • Error
      • JsForceError

    Properties

    errorCode +JsForceError | @salesforce/core
    interface JsForceError {
        errorCode: string;
        fields: string[];
    }

    Hierarchy

    • Error
      • JsForceError

    Properties

    Properties

    errorCode: string
    fields: string[]
    \ No newline at end of file +

    Properties

    errorCode: string
    fields: string[]
    \ No newline at end of file diff --git a/interfaces/status_streamingClient.StreamingClient.Options.html b/interfaces/status_streamingClient.StreamingClient.Options.html index edb44e990..835658d02 100644 --- a/interfaces/status_streamingClient.StreamingClient.Options.html +++ b/interfaces/status_streamingClient.StreamingClient.Options.html @@ -1,5 +1,5 @@ Options | @salesforce/core

    Options for the StreamingClient

    -
    interface Options {
        apiVersion: string;
        channel: string;
        handshakeTimeout: Duration;
        org: Org;
        streamProcessor: StreamProcessor;
        streamingImpl: StreamingClientIfc;
        subscribeTimeout: Duration;
    }

    Implemented by

    Properties

    interface Options {
        apiVersion: string;
        channel: string;
        handshakeTimeout: Duration;
        org: Org;
        streamProcessor: StreamProcessor;
        streamingImpl: StreamingClientIfc;
        subscribeTimeout: Duration;
    }

    Implemented by

    Properties

    apiVersion: string

    The salesforce api version

    -
    channel: string

    The streaming channel aka topic

    -
    handshakeTimeout: Duration

    The hard timeout that happens with a handshake.

    -
    org: Org

    The org streaming target.

    -
    streamProcessor: StreamProcessor

    The function for processing streaming messages

    -
    streamingImpl: StreamingClientIfc

    The function for build the inner client impl. Allows for mocking.

    -
    subscribeTimeout: Duration

    The hard timeout that happens with subscribe

    -
    \ No newline at end of file +
    channel: string

    The streaming channel aka topic

    +
    handshakeTimeout: Duration

    The hard timeout that happens with a handshake.

    +
    org: Org

    The org streaming target.

    +
    streamProcessor: StreamProcessor

    The function for processing streaming messages

    +
    streamingImpl: StreamingClientIfc

    The function for build the inner client impl. Allows for mocking.

    +
    subscribeTimeout: Duration

    The hard timeout that happens with subscribe

    +
    \ No newline at end of file diff --git a/modules/config_authInfoConfig.html b/modules/config_authInfoConfig.html index d1d37dbf6..7b77c074b 100644 --- a/modules/config_authInfoConfig.html +++ b/modules/config_authInfoConfig.html @@ -1,2 +1,2 @@ -config/authInfoConfig | @salesforce/core

    Module config/authInfoConfig

    Index

    Classes

    AuthInfoConfig +config/authInfoConfig | @salesforce/core
    \ No newline at end of file diff --git a/modules/config_config.html b/modules/config_config.html index f5e682824..382ff887f 100644 --- a/modules/config_config.html +++ b/modules/config_config.html @@ -1,4 +1,4 @@ -config/config | @salesforce/core

    Module config/config

    Index

    Enumerations

    SfConfigProperties +config/config | @salesforce/core

    Module config/config

    Index

    Enumerations

    Classes

    Type Aliases

    ConfigProperties diff --git a/modules/config_configAggregator.ConfigAggregator.html b/modules/config_configAggregator.ConfigAggregator.html index 1814173b0..d36da15ba 100644 --- a/modules/config_configAggregator.ConfigAggregator.html +++ b/modules/config_configAggregator.ConfigAggregator.html @@ -1,3 +1,3 @@ -ConfigAggregator | @salesforce/core

    Index

    Enumerations

    Location +ConfigAggregator | @salesforce/core
    \ No newline at end of file diff --git a/modules/config_configAggregator.html b/modules/config_configAggregator.html index 41b637d5f..d0bc2e374 100644 --- a/modules/config_configAggregator.html +++ b/modules/config_configAggregator.html @@ -1,4 +1,4 @@ -config/configAggregator | @salesforce/core

    Module config/configAggregator

    Index

    Namespaces

    ConfigAggregator +config/configAggregator | @salesforce/core

    Module config/configAggregator

    Index

    Namespaces

    Classes

    Type Aliases

    \ No newline at end of file diff --git a/modules/config_configFile.ConfigFile.html b/modules/config_configFile.ConfigFile.html index 7cf9e5f6a..327a404b3 100644 --- a/modules/config_configFile.ConfigFile.html +++ b/modules/config_configFile.ConfigFile.html @@ -1,2 +1,2 @@ -ConfigFile | @salesforce/core

    Index

    Type Aliases

    Options +ConfigFile | @salesforce/core
    \ No newline at end of file diff --git a/modules/config_configFile.html b/modules/config_configFile.html index 53eac1bee..182222d75 100644 --- a/modules/config_configFile.html +++ b/modules/config_configFile.html @@ -1,3 +1,3 @@ -config/configFile | @salesforce/core

    Module config/configFile

    Index

    Namespaces

    ConfigFile +config/configFile | @salesforce/core

    Module config/configFile

    Index

    Namespaces

    Classes

    \ No newline at end of file diff --git a/modules/config_configStackTypes.html b/modules/config_configStackTypes.html index 67380e2eb..a5c36eb06 100644 --- a/modules/config_configStackTypes.html +++ b/modules/config_configStackTypes.html @@ -1,4 +1,4 @@ -config/configStackTypes | @salesforce/core

    Module config/configStackTypes

    Index

    Type Aliases

    ConfigContents +config/configStackTypes | @salesforce/core

    Module config/configStackTypes

    Index

    Type Aliases

    ConfigContents ConfigEntry ConfigValue Key diff --git a/modules/config_configStore.html b/modules/config_configStore.html index 73c66e4e8..b56414c8b 100644 --- a/modules/config_configStore.html +++ b/modules/config_configStore.html @@ -1,3 +1,3 @@ -config/configStore | @salesforce/core

    Module config/configStore

    Index

    Classes

    BaseConfigStore +config/configStore | @salesforce/core

    Module config/configStore

    Index

    Classes

    Type Aliases

    \ No newline at end of file diff --git a/modules/config_envVars.html b/modules/config_envVars.html index 2be9ee790..fcaf118dd 100644 --- a/modules/config_envVars.html +++ b/modules/config_envVars.html @@ -1,4 +1,4 @@ -config/envVars | @salesforce/core

    Module config/envVars

    Index

    Enumerations

    EnvironmentVariable +config/envVars | @salesforce/core

    Module config/envVars

    Index

    Enumerations

    Classes

    Variables

    SUPPORTED_ENV_VARS envVars diff --git a/modules/config_lwwMap.html b/modules/config_lwwMap.html index 54568d263..fc4045daf 100644 --- a/modules/config_lwwMap.html +++ b/modules/config_lwwMap.html @@ -1,4 +1,4 @@ -config/lwwMap | @salesforce/core

    Module config/lwwMap

    Index

    Classes

    LWWMap +config/lwwMap | @salesforce/core

    Module config/lwwMap

    Index

    Classes

    Type Aliases

    Variables

    Functions

    stateFromContents diff --git a/modules/config_lwwRegister.html b/modules/config_lwwRegister.html index 7f26449bc..bb8646675 100644 --- a/modules/config_lwwRegister.html +++ b/modules/config_lwwRegister.html @@ -1,2 +1,2 @@ -config/lwwRegister | @salesforce/core

    Module config/lwwRegister

    Index

    Classes

    LWWRegister +config/lwwRegister | @salesforce/core

    Module config/lwwRegister

    Index

    Classes

    \ No newline at end of file diff --git a/modules/config_orgUsersConfig.OrgUsersConfig.html b/modules/config_orgUsersConfig.OrgUsersConfig.html index 8fa90af1b..b3c577145 100644 --- a/modules/config_orgUsersConfig.OrgUsersConfig.html +++ b/modules/config_orgUsersConfig.OrgUsersConfig.html @@ -1,2 +1,2 @@ -OrgUsersConfig | @salesforce/core

    Index

    Type Aliases

    Options +OrgUsersConfig | @salesforce/core
    \ No newline at end of file diff --git a/modules/config_orgUsersConfig.html b/modules/config_orgUsersConfig.html index 760746566..6f25c2bf5 100644 --- a/modules/config_orgUsersConfig.html +++ b/modules/config_orgUsersConfig.html @@ -1,3 +1,3 @@ -config/orgUsersConfig | @salesforce/core

    Module config/orgUsersConfig

    Index

    Namespaces

    OrgUsersConfig +config/orgUsersConfig | @salesforce/core
    \ No newline at end of file diff --git a/modules/config_sandboxOrgConfig.SandboxOrgConfig.html b/modules/config_sandboxOrgConfig.SandboxOrgConfig.html index 043504db6..dd4d7edce 100644 --- a/modules/config_sandboxOrgConfig.SandboxOrgConfig.html +++ b/modules/config_sandboxOrgConfig.SandboxOrgConfig.html @@ -1,3 +1,3 @@ -SandboxOrgConfig | @salesforce/core

    Index

    Enumerations

    Fields +SandboxOrgConfig | @salesforce/core
    \ No newline at end of file diff --git a/modules/config_sandboxOrgConfig.html b/modules/config_sandboxOrgConfig.html index b5cacba0b..fd0580549 100644 --- a/modules/config_sandboxOrgConfig.html +++ b/modules/config_sandboxOrgConfig.html @@ -1,3 +1,3 @@ -config/sandboxOrgConfig | @salesforce/core

    Module config/sandboxOrgConfig

    Index

    Namespaces

    SandboxOrgConfig +config/sandboxOrgConfig | @salesforce/core
    \ No newline at end of file diff --git a/modules/config_sandboxProcessCache.html b/modules/config_sandboxProcessCache.html index ea6f81a95..edadedbe0 100644 --- a/modules/config_sandboxProcessCache.html +++ b/modules/config_sandboxProcessCache.html @@ -1,3 +1,3 @@ -config/sandboxProcessCache | @salesforce/core

    Module config/sandboxProcessCache

    Index

    Classes

    SandboxRequestCache +config/sandboxProcessCache | @salesforce/core
    \ No newline at end of file diff --git a/modules/config_ttlConfig.TTLConfig.html b/modules/config_ttlConfig.TTLConfig.html index 2d5533b3b..4f5fdc373 100644 --- a/modules/config_ttlConfig.TTLConfig.html +++ b/modules/config_ttlConfig.TTLConfig.html @@ -1,4 +1,4 @@ -TTLConfig | @salesforce/core

    Index

    Type Aliases

    Contents +TTLConfig | @salesforce/core
    \ No newline at end of file diff --git a/modules/config_ttlConfig.html b/modules/config_ttlConfig.html index 9e7e1b887..027b17745 100644 --- a/modules/config_ttlConfig.html +++ b/modules/config_ttlConfig.html @@ -1,3 +1,3 @@ -config/ttlConfig | @salesforce/core

    Module config/ttlConfig

    Index

    Namespaces

    TTLConfig +config/ttlConfig | @salesforce/core

    Module config/ttlConfig

    Index

    Namespaces

    Classes

    \ No newline at end of file diff --git a/modules/crypto_crypto.html b/modules/crypto_crypto.html index 77db30b80..71691c6b6 100644 --- a/modules/crypto_crypto.html +++ b/modules/crypto_crypto.html @@ -1,2 +1,2 @@ -crypto/crypto | @salesforce/core

    Module crypto/crypto

    Index

    Classes

    Crypto +crypto/crypto | @salesforce/core

    Module crypto/crypto

    Index

    Classes

    \ No newline at end of file diff --git a/modules/crypto_keyChain.html b/modules/crypto_keyChain.html index 476ff12cc..06542f5e2 100644 --- a/modules/crypto_keyChain.html +++ b/modules/crypto_keyChain.html @@ -1 +1 @@ -crypto/keyChain | @salesforce/core
    \ No newline at end of file +crypto/keyChain | @salesforce/core
    \ No newline at end of file diff --git a/modules/crypto_keyChainImpl.html b/modules/crypto_keyChainImpl.html index 7ce10489e..e85592405 100644 --- a/modules/crypto_keyChainImpl.html +++ b/modules/crypto_keyChainImpl.html @@ -1,4 +1,4 @@ -crypto/keyChainImpl | @salesforce/core

    Module crypto/keyChainImpl

    Index

    Classes

    GenericKeychainAccess +crypto/keyChainImpl | @salesforce/core

    Module crypto/keyChainImpl

    Index

    Classes

    Type Aliases

    FsIfc KeyChain PasswordStore diff --git a/modules/crypto_secureBuffer.html b/modules/crypto_secureBuffer.html index c310ea928..bea16a9b0 100644 --- a/modules/crypto_secureBuffer.html +++ b/modules/crypto_secureBuffer.html @@ -1,3 +1,3 @@ -crypto/secureBuffer | @salesforce/core

    Module crypto/secureBuffer

    Index

    Classes

    SecureBuffer +crypto/secureBuffer | @salesforce/core

    Module crypto/secureBuffer

    Index

    Classes

    Type Aliases

    \ No newline at end of file diff --git a/modules/deviceOauthService.html b/modules/deviceOauthService.html index 7ff6ab443..8ef7a41d1 100644 --- a/modules/deviceOauthService.html +++ b/modules/deviceOauthService.html @@ -1,4 +1,4 @@ -deviceOauthService | @salesforce/core

    Module deviceOauthService

    Index

    Classes

    DeviceOauthService +deviceOauthService | @salesforce/core
    \ No newline at end of file diff --git a/modules/global.html b/modules/global.html index f4c2c3e93..61ad84d52 100644 --- a/modules/global.html +++ b/modules/global.html @@ -1,3 +1,3 @@ -global | @salesforce/core

    Index

    Enumerations

    Mode +global | @salesforce/core

    Index

    Enumerations

    Classes

    \ No newline at end of file diff --git a/modules/index.html b/modules/index.html index 78f324324..692774714 100644 --- a/modules/index.html +++ b/modules/index.html @@ -1,4 +1,4 @@ -index | @salesforce/core

    References

    AuthFields +index | @salesforce/core

    References

    AuthFields AuthInfo AuthRemover AuthSideEffects diff --git a/modules/lifecycleEvents.html b/modules/lifecycleEvents.html index 8b084c8de..d7691aec3 100644 --- a/modules/lifecycleEvents.html +++ b/modules/lifecycleEvents.html @@ -1,4 +1,4 @@ -lifecycleEvents | @salesforce/core

    Module lifecycleEvents

    Index

    Classes

    Lifecycle +lifecycleEvents | @salesforce/core

    Module lifecycleEvents

    Index

    Classes

    Type Aliases

    Functions

    cloneUniqueListeners diff --git a/modules/logger_cleanup.html b/modules/logger_cleanup.html index 4908286eb..d267578fd 100644 --- a/modules/logger_cleanup.html +++ b/modules/logger_cleanup.html @@ -1,3 +1,3 @@ -logger/cleanup | @salesforce/core

    Module logger/cleanup

    Index

    Functions

    cleanup +logger/cleanup | @salesforce/core
    \ No newline at end of file diff --git a/modules/logger_filters.html b/modules/logger_filters.html index ba198a0d2..65e7fd9bc 100644 --- a/modules/logger_filters.html +++ b/modules/logger_filters.html @@ -1,3 +1,3 @@ -logger/filters | @salesforce/core

    Module logger/filters

    Index

    Variables

    HIDDEN +logger/filters | @salesforce/core

    Module logger/filters

    Index

    Variables

    Functions

    \ No newline at end of file diff --git a/modules/logger_logger.html b/modules/logger_logger.html index 0720572ec..a21d39ae4 100644 --- a/modules/logger_logger.html +++ b/modules/logger_logger.html @@ -1,4 +1,4 @@ -logger/logger | @salesforce/core

    Module logger/logger

    Index

    Enumerations

    LoggerLevel +logger/logger | @salesforce/core

    Module logger/logger

    Index

    Enumerations

    Classes

    Type Aliases

    FieldValue Fields diff --git a/modules/logger_memoryLogger.html b/modules/logger_memoryLogger.html index d94ebd55a..6a9cffe7b 100644 --- a/modules/logger_memoryLogger.html +++ b/modules/logger_memoryLogger.html @@ -1,2 +1,2 @@ -logger/memoryLogger | @salesforce/core

    Module logger/memoryLogger

    Index

    Classes

    MemoryLogger +logger/memoryLogger | @salesforce/core

    Module logger/memoryLogger

    Index

    Classes

    \ No newline at end of file diff --git a/modules/logger_transformStream.html b/modules/logger_transformStream.html index 23eb8cbb8..ac0ed8a16 100644 --- a/modules/logger_transformStream.html +++ b/modules/logger_transformStream.html @@ -1,2 +1,2 @@ -logger/transformStream | @salesforce/core

    Module logger/transformStream

    Index

    Functions

    default +logger/transformStream | @salesforce/core

    Module logger/transformStream

    Index

    Functions

    \ No newline at end of file diff --git a/modules/messageTransformer.html b/modules/messageTransformer.html index b29dce782..22ebe10e7 100644 --- a/modules/messageTransformer.html +++ b/modules/messageTransformer.html @@ -1,3 +1,3 @@ -messageTransformer | @salesforce/core

    Module messageTransformer

    References

    default +messageTransformer | @salesforce/core

    Module messageTransformer

    References

    Functions

    References

    Renames and re-exports messageTransformer
    \ No newline at end of file diff --git a/modules/messages.html b/modules/messages.html index b635db029..7a108f6f8 100644 --- a/modules/messages.html +++ b/modules/messages.html @@ -1,4 +1,4 @@ -messages | @salesforce/core

    Index

    Classes

    Messages +messages | @salesforce/core

    Index

    Classes

    Type Aliases

    LoaderFunction StoredMessage StoredMessageMap diff --git a/modules/org_authInfo.AuthInfo.html b/modules/org_authInfo.AuthInfo.html index 9e2edd496..c6908ff7d 100644 --- a/modules/org_authInfo.AuthInfo.html +++ b/modules/org_authInfo.AuthInfo.html @@ -1,2 +1,2 @@ -AuthInfo | @salesforce/core

    Index

    Type Aliases

    Options +AuthInfo | @salesforce/core
    \ No newline at end of file diff --git a/modules/org_authInfo.html b/modules/org_authInfo.html index 985ed27c2..71a4fd59a 100644 --- a/modules/org_authInfo.html +++ b/modules/org_authInfo.html @@ -1,4 +1,4 @@ -org/authInfo | @salesforce/core

    Module org/authInfo

    Index

    Namespaces

    AuthInfo +org/authInfo | @salesforce/core

    Module org/authInfo

    Index

    Namespaces

    Classes

    Type Aliases

    AccessTokenOptions AuthFields diff --git a/modules/org_authRemover.html b/modules/org_authRemover.html index 02397027f..07c8f298e 100644 --- a/modules/org_authRemover.html +++ b/modules/org_authRemover.html @@ -1,2 +1,2 @@ -org/authRemover | @salesforce/core

    Module org/authRemover

    Index

    Classes

    AuthRemover +org/authRemover | @salesforce/core

    Module org/authRemover

    Index

    Classes

    \ No newline at end of file diff --git a/modules/org_connection.Connection.html b/modules/org_connection.Connection.html index fdabfc983..329b724a0 100644 --- a/modules/org_connection.Connection.html +++ b/modules/org_connection.Connection.html @@ -1,2 +1,2 @@ -Connection | @salesforce/core

    Index

    Type Aliases

    Options +Connection | @salesforce/core
    \ No newline at end of file diff --git a/modules/org_connection.html b/modules/org_connection.html index dfae642cb..b9fe5d19f 100644 --- a/modules/org_connection.html +++ b/modules/org_connection.html @@ -1,4 +1,4 @@ -org/connection | @salesforce/core

    Module org/connection

    Index

    Namespaces

    Connection +org/connection | @salesforce/core

    Module org/connection

    Index

    Namespaces

    Classes

    Interfaces

    Type Aliases

    DeployOptionsWithRest diff --git a/modules/org_org.Org.html b/modules/org_org.Org.html index dcdfbf391..bc95a28e0 100644 --- a/modules/org_org.Org.html +++ b/modules/org_org.Org.html @@ -1,4 +1,4 @@ -Org | @salesforce/core

    Index

    Enumerations

    Fields +Org | @salesforce/core

    Index

    Enumerations

    Type Aliases

    \ No newline at end of file diff --git a/modules/org_org.html b/modules/org_org.html index 7a9f46a17..bab379eb8 100644 --- a/modules/org_org.html +++ b/modules/org_org.html @@ -1,4 +1,4 @@ -org/org | @salesforce/core

    Index

    Namespaces

    Org +org/org | @salesforce/core

    Index

    Namespaces

    Enumerations

    Classes

    Org diff --git a/modules/org_orgConfigProperties.html b/modules/org_orgConfigProperties.html index 84060658d..52b51b567 100644 --- a/modules/org_orgConfigProperties.html +++ b/modules/org_orgConfigProperties.html @@ -1,3 +1,3 @@ -org/orgConfigProperties | @salesforce/core

    Module org/orgConfigProperties

    Index

    Enumerations

    OrgConfigProperties +org/orgConfigProperties | @salesforce/core
    \ No newline at end of file diff --git a/modules/org_permissionSetAssignment.html b/modules/org_permissionSetAssignment.html index 8c1575b5b..137e6aac2 100644 --- a/modules/org_permissionSetAssignment.html +++ b/modules/org_permissionSetAssignment.html @@ -1,3 +1,3 @@ -org/permissionSetAssignment | @salesforce/core

    Module org/permissionSetAssignment

    Index

    Classes

    PermissionSetAssignment +org/permissionSetAssignment | @salesforce/core
    \ No newline at end of file diff --git a/modules/org_scratchOrgCache.html b/modules/org_scratchOrgCache.html index dec970f65..621ac253a 100644 --- a/modules/org_scratchOrgCache.html +++ b/modules/org_scratchOrgCache.html @@ -1,3 +1,3 @@ -org/scratchOrgCache | @salesforce/core

    Module org/scratchOrgCache

    Index

    Classes

    ScratchOrgCache +org/scratchOrgCache | @salesforce/core

    Module org/scratchOrgCache

    Index

    Classes

    Type Aliases

    \ No newline at end of file diff --git a/modules/org_scratchOrgCreate.html b/modules/org_scratchOrgCreate.html index a4867e031..e1eea8e2d 100644 --- a/modules/org_scratchOrgCreate.html +++ b/modules/org_scratchOrgCreate.html @@ -1,4 +1,4 @@ -org/scratchOrgCreate | @salesforce/core

    Module org/scratchOrgCreate

    Index

    Type Aliases

    ScratchOrgCreateOptions +org/scratchOrgCreate | @salesforce/core

    Module org/scratchOrgCreate

    Index

    Type Aliases

    Variables

    Functions

    scratchOrgCreate diff --git a/modules/org_scratchOrgErrorCodes.html b/modules/org_scratchOrgErrorCodes.html index 5784d9cfd..b7111e720 100644 --- a/modules/org_scratchOrgErrorCodes.html +++ b/modules/org_scratchOrgErrorCodes.html @@ -1,3 +1,3 @@ -org/scratchOrgErrorCodes | @salesforce/core

    Module org/scratchOrgErrorCodes

    Index

    Functions

    checkScratchOrgInfoForErrors +org/scratchOrgErrorCodes | @salesforce/core
    \ No newline at end of file diff --git a/modules/org_scratchOrgFeatureDeprecation.html b/modules/org_scratchOrgFeatureDeprecation.html index addf57e98..a6e5da3df 100644 --- a/modules/org_scratchOrgFeatureDeprecation.html +++ b/modules/org_scratchOrgFeatureDeprecation.html @@ -1,2 +1,2 @@ -org/scratchOrgFeatureDeprecation | @salesforce/core

    Module org/scratchOrgFeatureDeprecation

    Index

    Classes

    ScratchOrgFeatureDeprecation +org/scratchOrgFeatureDeprecation | @salesforce/core
    \ No newline at end of file diff --git a/modules/org_scratchOrgInfoApi.html b/modules/org_scratchOrgInfoApi.html index 866303048..67c54e843 100644 --- a/modules/org_scratchOrgInfoApi.html +++ b/modules/org_scratchOrgInfoApi.html @@ -1,4 +1,4 @@ -org/scratchOrgInfoApi | @salesforce/core

    Module org/scratchOrgInfoApi

    Index

    Interfaces

    JsForceError +org/scratchOrgInfoApi | @salesforce/core

    Module org/scratchOrgInfoApi

    Index

    Interfaces

    Functions

    authorizeScratchOrg deploySettings pollForScratchOrgInfo diff --git a/modules/org_scratchOrgInfoGenerator.html b/modules/org_scratchOrgInfoGenerator.html index 508effde2..505c13239 100644 --- a/modules/org_scratchOrgInfoGenerator.html +++ b/modules/org_scratchOrgInfoGenerator.html @@ -1,4 +1,4 @@ -org/scratchOrgInfoGenerator | @salesforce/core

    Module org/scratchOrgInfoGenerator

    Index

    Type Aliases

    ScratchOrgInfoPayload +org/scratchOrgInfoGenerator | @salesforce/core

    Module org/scratchOrgInfoGenerator

    Index

    Type Aliases

    Functions

    generateScratchOrgInfo getAncestorIds getScratchOrgInfoPayload diff --git a/modules/org_scratchOrgLifecycleEvents.html b/modules/org_scratchOrgLifecycleEvents.html index 72b91cf9c..78e29a308 100644 --- a/modules/org_scratchOrgLifecycleEvents.html +++ b/modules/org_scratchOrgLifecycleEvents.html @@ -1,4 +1,4 @@ -org/scratchOrgLifecycleEvents | @salesforce/core

    Module org/scratchOrgLifecycleEvents

    Index

    Type Aliases

    ScratchOrgLifecycleEvent +org/scratchOrgLifecycleEvents | @salesforce/core

    Module org/scratchOrgLifecycleEvents

    Index

    Type Aliases

    Variables

    Functions

    emit diff --git a/modules/org_scratchOrgSettingsGenerator.html b/modules/org_scratchOrgSettingsGenerator.html index 91c908d01..f8a8f1cf1 100644 --- a/modules/org_scratchOrgSettingsGenerator.html +++ b/modules/org_scratchOrgSettingsGenerator.html @@ -1,4 +1,4 @@ -org/scratchOrgSettingsGenerator | @salesforce/core

    Module org/scratchOrgSettingsGenerator

    Index

    Enumerations

    RequestStatus +org/scratchOrgSettingsGenerator | @salesforce/core

    Module org/scratchOrgSettingsGenerator

    Index

    Enumerations

    Classes

    Type Aliases

    PackageFile SettingType diff --git a/modules/org_scratchOrgTypes.html b/modules/org_scratchOrgTypes.html index 427ce39b6..12cef839c 100644 --- a/modules/org_scratchOrgTypes.html +++ b/modules/org_scratchOrgTypes.html @@ -1,3 +1,3 @@ -org/scratchOrgTypes | @salesforce/core

    Module org/scratchOrgTypes

    Index

    Type Aliases

    ObjectSetting +org/scratchOrgTypes | @salesforce/core
    \ No newline at end of file diff --git a/modules/org_user.DefaultUserFields.html b/modules/org_user.DefaultUserFields.html index f30f42a15..fbe2b37b7 100644 --- a/modules/org_user.DefaultUserFields.html +++ b/modules/org_user.DefaultUserFields.html @@ -1,2 +1,2 @@ -DefaultUserFields | @salesforce/core

    Index

    Type Aliases

    Options +DefaultUserFields | @salesforce/core

    Index

    Type Aliases

    \ No newline at end of file diff --git a/modules/org_user.User.html b/modules/org_user.User.html index b14840c88..3474db3c0 100644 --- a/modules/org_user.User.html +++ b/modules/org_user.User.html @@ -1,2 +1,2 @@ -User | @salesforce/core

    Index

    Type Aliases

    Options +User | @salesforce/core

    Index

    Type Aliases

    \ No newline at end of file diff --git a/modules/org_user.html b/modules/org_user.html index 4e7823778..2ce90c653 100644 --- a/modules/org_user.html +++ b/modules/org_user.html @@ -1,4 +1,4 @@ -org/user | @salesforce/core

    Index

    Namespaces

    DefaultUserFields +org/user | @salesforce/core

    Index

    Namespaces

    Classes

    DefaultUserFields User diff --git a/modules/schema_validator.html b/modules/schema_validator.html index b2dac7e8f..9f0e224ab 100644 --- a/modules/schema_validator.html +++ b/modules/schema_validator.html @@ -1,2 +1,2 @@ -schema/validator | @salesforce/core

    Module schema/validator

    Index

    Classes

    SchemaValidator +schema/validator | @salesforce/core
    \ No newline at end of file diff --git a/modules/sfError.html b/modules/sfError.html index 5f2ffa779..0af435e6d 100644 --- a/modules/sfError.html +++ b/modules/sfError.html @@ -1,3 +1,3 @@ -sfError | @salesforce/core

    Index

    Classes

    SfError +sfError | @salesforce/core

    Index

    Classes

    Type Aliases

    \ No newline at end of file diff --git a/modules/sfProject.html b/modules/sfProject.html index 784169925..52fd9a619 100644 --- a/modules/sfProject.html +++ b/modules/sfProject.html @@ -1,4 +1,4 @@ -sfProject | @salesforce/core

    Index

    Classes

    SfProject +sfProject | @salesforce/core

    Index

    Classes

    Type Aliases

    NamedPackageDir NamedPackagingDir diff --git a/modules/stateAggregator_accessors_aliasAccessor.html b/modules/stateAggregator_accessors_aliasAccessor.html index 9e2214824..e105136f0 100644 --- a/modules/stateAggregator_accessors_aliasAccessor.html +++ b/modules/stateAggregator_accessors_aliasAccessor.html @@ -1,4 +1,4 @@ -stateAggregator/accessors/aliasAccessor | @salesforce/core

    Module stateAggregator/accessors/aliasAccessor

    Index

    Classes

    AliasAccessor +stateAggregator/accessors/aliasAccessor | @salesforce/core

    Module stateAggregator/accessors/aliasAccessor

    Index

    Classes

    Type Aliases

    Variables

    DEFAULT_GROUP FILENAME diff --git a/modules/stateAggregator_accessors_orgAccessor.html b/modules/stateAggregator_accessors_orgAccessor.html index a64ec990c..9c8e3af3c 100644 --- a/modules/stateAggregator_accessors_orgAccessor.html +++ b/modules/stateAggregator_accessors_orgAccessor.html @@ -1,3 +1,3 @@ -stateAggregator/accessors/orgAccessor | @salesforce/core

    Module stateAggregator/accessors/orgAccessor

    Index

    Classes

    BaseOrgAccessor +stateAggregator/accessors/orgAccessor | @salesforce/core
    \ No newline at end of file diff --git a/modules/stateAggregator_accessors_sandboxAccessor.html b/modules/stateAggregator_accessors_sandboxAccessor.html index 11733b97d..6d1f12a70 100644 --- a/modules/stateAggregator_accessors_sandboxAccessor.html +++ b/modules/stateAggregator_accessors_sandboxAccessor.html @@ -1,2 +1,2 @@ -stateAggregator/accessors/sandboxAccessor | @salesforce/core

    Module stateAggregator/accessors/sandboxAccessor

    Index

    Classes

    SandboxAccessor +stateAggregator/accessors/sandboxAccessor | @salesforce/core
    \ No newline at end of file diff --git a/modules/stateAggregator_stateAggregator.html b/modules/stateAggregator_stateAggregator.html index 835fa79ad..605834769 100644 --- a/modules/stateAggregator_stateAggregator.html +++ b/modules/stateAggregator_stateAggregator.html @@ -1,2 +1,2 @@ -stateAggregator/stateAggregator | @salesforce/core

    Module stateAggregator/stateAggregator

    Index

    Classes

    StateAggregator +stateAggregator/stateAggregator | @salesforce/core
    \ No newline at end of file diff --git a/modules/status_myDomainResolver.MyDomainResolver.html b/modules/status_myDomainResolver.MyDomainResolver.html index 1a73f11de..6c75a880d 100644 --- a/modules/status_myDomainResolver.MyDomainResolver.html +++ b/modules/status_myDomainResolver.MyDomainResolver.html @@ -1,2 +1,2 @@ -MyDomainResolver | @salesforce/core

    Index

    Type Aliases

    Options +MyDomainResolver | @salesforce/core
    \ No newline at end of file diff --git a/modules/status_myDomainResolver.html b/modules/status_myDomainResolver.html index 81209d71e..714e84098 100644 --- a/modules/status_myDomainResolver.html +++ b/modules/status_myDomainResolver.html @@ -1,3 +1,3 @@ -status/myDomainResolver | @salesforce/core

    Module status/myDomainResolver

    Index

    Namespaces

    MyDomainResolver +status/myDomainResolver | @salesforce/core
    \ No newline at end of file diff --git a/modules/status_pollingClient.PollingClient.html b/modules/status_pollingClient.PollingClient.html index 7dea071fe..ca641c3ce 100644 --- a/modules/status_pollingClient.PollingClient.html +++ b/modules/status_pollingClient.PollingClient.html @@ -1,3 +1,3 @@ -PollingClient | @salesforce/core

    Index

    Classes

    DefaultPollingOptions +PollingClient | @salesforce/core
    \ No newline at end of file diff --git a/modules/status_pollingClient.html b/modules/status_pollingClient.html index 21404e6fa..895b34c5e 100644 --- a/modules/status_pollingClient.html +++ b/modules/status_pollingClient.html @@ -1,3 +1,3 @@ -status/pollingClient | @salesforce/core

    Module status/pollingClient

    Index

    Namespaces

    PollingClient +status/pollingClient | @salesforce/core

    Module status/pollingClient

    Index

    Namespaces

    Classes

    \ No newline at end of file diff --git a/modules/status_streamingClient.StreamingClient.html b/modules/status_streamingClient.StreamingClient.html index 4c4d6754e..772b9c4f8 100644 --- a/modules/status_streamingClient.StreamingClient.html +++ b/modules/status_streamingClient.StreamingClient.html @@ -1,4 +1,4 @@ -StreamingClient | @salesforce/core

    Index

    Enumerations

    ConnectionState +StreamingClient | @salesforce/core

    Index

    Enumerations

    Classes

    Interfaces

    Options diff --git a/modules/status_streamingClient.html b/modules/status_streamingClient.html index 677349b32..072e4e1a4 100644 --- a/modules/status_streamingClient.html +++ b/modules/status_streamingClient.html @@ -1,4 +1,4 @@ -status/streamingClient | @salesforce/core

    Module status/streamingClient

    References

    CometClient +status/streamingClient | @salesforce/core

    Module status/streamingClient

    References

    CometClient CometSubscription Message StatusResult diff --git a/modules/status_types.html b/modules/status_types.html index 8d78694a5..d78abcf60 100644 --- a/modules/status_types.html +++ b/modules/status_types.html @@ -1,4 +1,4 @@ -status/types | @salesforce/core

    Module status/types

    Index

    Classes

    CometClient +status/types | @salesforce/core

    Module status/types

    Index

    Classes

    Type Aliases

    Callback CometSubscription Message diff --git a/modules/testSetup.html b/modules/testSetup.html index 10a5ad29f..b9e4f342a 100644 --- a/modules/testSetup.html +++ b/modules/testSetup.html @@ -1,4 +1,4 @@ -testSetup | @salesforce/core

    References

    SecureBuffer +testSetup | @salesforce/core

    References

    Enumerations

    Classes

    MockTestOrgData diff --git a/modules/util_cache.html b/modules/util_cache.html index 17d9a853f..7afe0afcb 100644 --- a/modules/util_cache.html +++ b/modules/util_cache.html @@ -1,2 +1,2 @@ -util/cache | @salesforce/core

    Index

    Classes

    Cache +util/cache | @salesforce/core

    Index

    Classes

    \ No newline at end of file diff --git a/modules/util_directoryWriter.html b/modules/util_directoryWriter.html index f1fb05913..bfb48f1d3 100644 --- a/modules/util_directoryWriter.html +++ b/modules/util_directoryWriter.html @@ -1,2 +1,2 @@ -util/directoryWriter | @salesforce/core

    Module util/directoryWriter

    Index

    Classes

    DirectoryWriter +util/directoryWriter | @salesforce/core
    \ No newline at end of file diff --git a/modules/util_fileLocking.html b/modules/util_fileLocking.html index 1b90f419a..1ed0f938b 100644 --- a/modules/util_fileLocking.html +++ b/modules/util_fileLocking.html @@ -1,4 +1,4 @@ -util/fileLocking | @salesforce/core

    Module util/fileLocking

    Index

    Functions

    lockInit +util/fileLocking | @salesforce/core

    Module util/fileLocking

    Index

    Functions

    lockInit lockInitSync pollUntilUnlock pollUntilUnlockSync diff --git a/modules/util_findSuggestion.html b/modules/util_findSuggestion.html index ff2b68e51..553fbaf81 100644 --- a/modules/util_findSuggestion.html +++ b/modules/util_findSuggestion.html @@ -1,2 +1,2 @@ -util/findSuggestion | @salesforce/core

    Module util/findSuggestion

    Index

    Functions

    findSuggestion +util/findSuggestion | @salesforce/core

    Module util/findSuggestion

    Index

    Functions

    \ No newline at end of file diff --git a/modules/util_findUppercaseKeys.html b/modules/util_findUppercaseKeys.html index b1ad8430d..20fe2745a 100644 --- a/modules/util_findUppercaseKeys.html +++ b/modules/util_findUppercaseKeys.html @@ -1,2 +1,2 @@ -util/findUppercaseKeys | @salesforce/core

    Module util/findUppercaseKeys

    Index

    Functions

    ensureNoUppercaseKeys +util/findUppercaseKeys | @salesforce/core
    \ No newline at end of file diff --git a/modules/util_getJwtAudienceUrl.html b/modules/util_getJwtAudienceUrl.html index aae81c6f3..4037a2f40 100644 --- a/modules/util_getJwtAudienceUrl.html +++ b/modules/util_getJwtAudienceUrl.html @@ -1,2 +1,2 @@ -util/getJwtAudienceUrl | @salesforce/core

    Module util/getJwtAudienceUrl

    Index

    Functions

    getJwtAudienceUrl +util/getJwtAudienceUrl | @salesforce/core
    \ No newline at end of file diff --git a/modules/util_internal.html b/modules/util_internal.html index 39b6854b0..560724949 100644 --- a/modules/util_internal.html +++ b/modules/util_internal.html @@ -1,2 +1,2 @@ -util/internal | @salesforce/core

    Module util/internal

    Index

    Variables

    traverse +util/internal | @salesforce/core

    Module util/internal

    Index

    Variables

    \ No newline at end of file diff --git a/modules/util_lockRetryOptions.html b/modules/util_lockRetryOptions.html index 65fef4351..6dadff56b 100644 --- a/modules/util_lockRetryOptions.html +++ b/modules/util_lockRetryOptions.html @@ -1,3 +1,3 @@ -util/lockRetryOptions | @salesforce/core

    Module util/lockRetryOptions

    Index

    Variables

    lockOptions +util/lockRetryOptions | @salesforce/core
    \ No newline at end of file diff --git a/modules/util_mapKeys.html b/modules/util_mapKeys.html index bcb997bf8..10643ec77 100644 --- a/modules/util_mapKeys.html +++ b/modules/util_mapKeys.html @@ -1,2 +1,2 @@ -util/mapKeys | @salesforce/core

    Module util/mapKeys

    Index

    Functions

    default +util/mapKeys | @salesforce/core

    Module util/mapKeys

    Index

    Functions

    \ No newline at end of file diff --git a/modules/util_sfdc.html b/modules/util_sfdc.html index 78178d3d5..966cd60c3 100644 --- a/modules/util_sfdc.html +++ b/modules/util_sfdc.html @@ -1,4 +1,4 @@ -util/sfdc | @salesforce/core

    Index

    Variables

    accessTokenRegex +util/sfdc | @salesforce/core

    Index

    Variables

    Functions

    matchesAccessToken trimTo15 diff --git a/modules/util_sfdcUrl.html b/modules/util_sfdcUrl.html index ff7fa6836..1a4956c53 100644 --- a/modules/util_sfdcUrl.html +++ b/modules/util_sfdcUrl.html @@ -1,3 +1,3 @@ -util/sfdcUrl | @salesforce/core

    Module util/sfdcUrl

    Index

    Classes

    SfdcUrl +util/sfdcUrl | @salesforce/core

    Module util/sfdcUrl

    Index

    Classes

    Functions

    \ No newline at end of file diff --git a/modules/util_structuredWriter.html b/modules/util_structuredWriter.html index f80fd4656..8cd94f017 100644 --- a/modules/util_structuredWriter.html +++ b/modules/util_structuredWriter.html @@ -1,2 +1,2 @@ -util/structuredWriter | @salesforce/core

    Module util/structuredWriter

    Index

    Type Aliases

    StructuredWriter +util/structuredWriter | @salesforce/core

    Module util/structuredWriter

    Index

    Type Aliases

    \ No newline at end of file diff --git a/modules/util_time.html b/modules/util_time.html index 78b3da954..19c7a5f09 100644 --- a/modules/util_time.html +++ b/modules/util_time.html @@ -1,2 +1,2 @@ -util/time | @salesforce/core

    Index

    Functions

    nowBigInt +util/time | @salesforce/core

    Index

    Functions

    \ No newline at end of file diff --git a/modules/util_uniqid.html b/modules/util_uniqid.html index 68dfae4c7..152d5a8b4 100644 --- a/modules/util_uniqid.html +++ b/modules/util_uniqid.html @@ -1,2 +1,2 @@ -util/uniqid | @salesforce/core

    Module util/uniqid

    Index

    Functions

    uniqid +util/uniqid | @salesforce/core

    Module util/uniqid

    Index

    Functions

    \ No newline at end of file diff --git a/modules/util_unwrapArray.html b/modules/util_unwrapArray.html index 8e9d43478..3b3d0a512 100644 --- a/modules/util_unwrapArray.html +++ b/modules/util_unwrapArray.html @@ -1,2 +1,2 @@ -util/unwrapArray | @salesforce/core

    Module util/unwrapArray

    Index

    Functions

    unwrapArray +util/unwrapArray | @salesforce/core

    Module util/unwrapArray

    Index

    Functions

    \ No newline at end of file diff --git a/modules/util_zipWriter.html b/modules/util_zipWriter.html index 4f58114b6..5ae563bb1 100644 --- a/modules/util_zipWriter.html +++ b/modules/util_zipWriter.html @@ -1,2 +1,2 @@ -util/zipWriter | @salesforce/core

    Module util/zipWriter

    Index

    Classes

    ZipWriter +util/zipWriter | @salesforce/core

    Module util/zipWriter

    Index

    Classes

    \ No newline at end of file diff --git a/modules/webOAuthServer.WebOAuthServer.html b/modules/webOAuthServer.WebOAuthServer.html index 306b00262..5b2661847 100644 --- a/modules/webOAuthServer.WebOAuthServer.html +++ b/modules/webOAuthServer.WebOAuthServer.html @@ -1,3 +1,3 @@ -WebOAuthServer | @salesforce/core

    Index

    Type Aliases

    Options +WebOAuthServer | @salesforce/core
    \ No newline at end of file diff --git a/modules/webOAuthServer.html b/modules/webOAuthServer.html index 1da49d442..0e9a34c41 100644 --- a/modules/webOAuthServer.html +++ b/modules/webOAuthServer.html @@ -1,4 +1,4 @@ -webOAuthServer | @salesforce/core

    Module webOAuthServer

    Index

    Namespaces

    WebOAuthServer +webOAuthServer | @salesforce/core
    \ No newline at end of file diff --git a/types/config_config.ConfigProperties.html b/types/config_config.ConfigProperties.html index 51f01bc6a..40b883853 100644 --- a/types/config_config.ConfigProperties.html +++ b/types/config_config.ConfigProperties.html @@ -1 +1 @@ -ConfigProperties | @salesforce/core
    ConfigProperties: ConfigContents
    \ No newline at end of file +ConfigProperties | @salesforce/core
    ConfigProperties: ConfigContents
    \ No newline at end of file diff --git a/types/config_config.ConfigPropertyMeta.html b/types/config_config.ConfigPropertyMeta.html index f59c48dc7..279bcea99 100644 --- a/types/config_config.ConfigPropertyMeta.html +++ b/types/config_config.ConfigPropertyMeta.html @@ -7,4 +7,4 @@
  • key: string

    The config property name.

  • Optional newKey?: string

    Reference to config property name that will eventually replace this one. Is only used if deprecated is set to true.

    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/config_config.ConfigPropertyMetaInput.html b/types/config_config.ConfigPropertyMetaInput.html index c4ffb7605..ff7aaacbf 100644 --- a/types/config_config.ConfigPropertyMetaInput.html +++ b/types/config_config.ConfigPropertyMetaInput.html @@ -2,4 +2,4 @@

    Type declaration

    • failedMessage: string | ((value) => string)

      The message to return in the error if the validation fails.

    • validator: ((value) => boolean)

      Tests if the input value is valid and returns true if the input data is valid.

        • (value): boolean
        • Parameters

          Returns boolean

    \ No newline at end of file +

    Returns boolean

    \ No newline at end of file diff --git a/types/config_configAggregator.ConfigAggregator.Options.html b/types/config_configAggregator.ConfigAggregator.Options.html index 0ee653525..2bf8c5555 100644 --- a/types/config_configAggregator.ConfigAggregator.Options.html +++ b/types/config_configAggregator.ConfigAggregator.Options.html @@ -1 +1 @@ -Options | @salesforce/core
    Options: {
        customConfigMeta?: ConfigPropertyMeta[];
    }

    Type declaration

    \ No newline at end of file +Options | @salesforce/core
    Options: {
        customConfigMeta?: ConfigPropertyMeta[];
    }

    Type declaration

    \ No newline at end of file diff --git a/types/config_configAggregator.ConfigInfo.html b/types/config_configAggregator.ConfigInfo.html index a95438888..20d33f513 100644 --- a/types/config_configAggregator.ConfigInfo.html +++ b/types/config_configAggregator.ConfigInfo.html @@ -7,4 +7,4 @@
  • Optional location?: Location

    The location of the config property.

  • Optional path?: string

    The path of the config value.

  • Optional value?: AnyJson

    The config value.

    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/config_configFile.ConfigFile.Options.html b/types/config_configFile.ConfigFile.Options.html index f59d0fe01..23430badb 100644 --- a/types/config_configFile.ConfigFile.Options.html +++ b/types/config_configFile.ConfigFile.Options.html @@ -6,4 +6,4 @@
  • 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.

    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/config_configStackTypes.ConfigContents.html b/types/config_configStackTypes.ConfigContents.html index 29ba13196..d0306c38a 100644 --- a/types/config_configStackTypes.ConfigContents.html +++ b/types/config_configStackTypes.ConfigContents.html @@ -1,2 +1,2 @@ ConfigContents | @salesforce/core
    ConfigContents<T>: Dictionary<T>

    The type of content a config stores.

    -

    Type Parameters

    \ No newline at end of file +

    Type Parameters

    \ No newline at end of file diff --git a/types/config_configStackTypes.ConfigEntry.html b/types/config_configStackTypes.ConfigEntry.html index e2dbabbef..4232a2ae3 100644 --- a/types/config_configStackTypes.ConfigEntry.html +++ b/types/config_configStackTypes.ConfigEntry.html @@ -1,2 +1,2 @@ ConfigEntry | @salesforce/core
    ConfigEntry: [string, ConfigValue]

    The type of entries in a config store defined by the key and value type of ConfigContents.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/config_configStackTypes.ConfigValue.html b/types/config_configStackTypes.ConfigValue.html index c17c40d2e..e2728ebcc 100644 --- a/types/config_configStackTypes.ConfigValue.html +++ b/types/config_configStackTypes.ConfigValue.html @@ -1,2 +1,2 @@ ConfigValue | @salesforce/core
    ConfigValue: AnyJson

    The allowed types stored in a config store.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/config_configStackTypes.Key.html b/types/config_configStackTypes.Key.html index 574f917b2..1caca3336 100644 --- a/types/config_configStackTypes.Key.html +++ b/types/config_configStackTypes.Key.html @@ -1 +1 @@ -Key | @salesforce/core
    Key<P>: Extract<keyof P, string>

    Type Parameters

    \ No newline at end of file +Key | @salesforce/core
    Key<P>: Extract<keyof P, string>

    Type Parameters

    \ No newline at end of file diff --git a/types/config_configStore.ConfigStore.html b/types/config_configStore.ConfigStore.html index 1b37304c8..a975998d8 100644 --- a/types/config_configStore.ConfigStore.html +++ b/types/config_configStore.ConfigStore.html @@ -1,2 +1,2 @@ ConfigStore | @salesforce/core
    ConfigStore<P>: {
        clear(): void;
        entries(): ConfigEntry[];
        forEach(actionFn): void;
        get<K>(key, decrypt): P[K];
        get<T>(key, decrypt): T;
        getContents(): P;
        getKeysByValue(value): Key<P>[];
        has(key): boolean;
        keys(): Key<P>[];
        set<K>(key, value): void;
        set<T>(key, value): void;
        unset(key): boolean;
        unsetAll(keys): boolean;
        update<K>(key, value): void;
        update<T>(key, value): void;
        values(): AnyJson[];
    }

    An interface for a config object with a persistent store.

    -

    Type Parameters

    Type declaration

    \ No newline at end of file +

    Type Parameters

    Type declaration

    \ No newline at end of file diff --git a/types/config_lwwMap.LWWState.html b/types/config_lwwMap.LWWState.html index 929741b96..515ead726 100644 --- a/types/config_lwwMap.LWWState.html +++ b/types/config_lwwMap.LWWState.html @@ -1 +1 @@ -LWWState | @salesforce/core
    LWWState<P>: {
        [Property in keyof P]: LWWRegister<P[Property] | typeof SYMBOL_FOR_DELETED>["state"]
    }

    Type Parameters

    • P
    \ No newline at end of file +LWWState | @salesforce/core
    LWWState<P>: {
        [Property in keyof P]: LWWRegister<P[Property] | typeof SYMBOL_FOR_DELETED>["state"]
    }

    Type Parameters

    • P
    \ No newline at end of file diff --git a/types/config_orgUsersConfig.OrgUsersConfig.Options.html b/types/config_orgUsersConfig.OrgUsersConfig.Options.html index 15d653b6f..2777d8b77 100644 --- a/types/config_orgUsersConfig.OrgUsersConfig.Options.html +++ b/types/config_orgUsersConfig.OrgUsersConfig.Options.html @@ -1,3 +1,3 @@ Options | @salesforce/core
    Options: {
        orgId: string;
    } & ConfigFile.Options

    The config file options.

    Type declaration

    • orgId: string

      The org id associated with this user.

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/config_sandboxOrgConfig.SandboxOrgConfig.Options.html b/types/config_sandboxOrgConfig.SandboxOrgConfig.Options.html index f77021c07..56e1b38e6 100644 --- a/types/config_sandboxOrgConfig.SandboxOrgConfig.Options.html +++ b/types/config_sandboxOrgConfig.SandboxOrgConfig.Options.html @@ -1,3 +1,3 @@ Options | @salesforce/core
    Options: {
        orgId: string;
    } & ConfigFile.Options

    The config file options.

    Type declaration

    • orgId: string

      The org id associated with this sandbox.

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/config_sandboxProcessCache.SandboxRequestCacheEntry.html b/types/config_sandboxProcessCache.SandboxRequestCacheEntry.html index afeb8abd1..0d1e4ade2 100644 --- a/types/config_sandboxProcessCache.SandboxRequestCacheEntry.html +++ b/types/config_sandboxProcessCache.SandboxRequestCacheEntry.html @@ -1 +1 @@ -SandboxRequestCacheEntry | @salesforce/core
    SandboxRequestCacheEntry: {
        action: "Create" | "Refresh";
        alias?: string;
        prodOrgUsername: string;
        sandboxProcessObject: Partial<SandboxProcessObject>;
        sandboxRequest: Partial<SandboxRequest>;
        setDefault?: boolean;
        tracksSource?: boolean;
    }

    Type declaration

    • action: "Create" | "Refresh"
    • Optional alias?: string
    • prodOrgUsername: string
    • sandboxProcessObject: Partial<SandboxProcessObject>
    • sandboxRequest: Partial<SandboxRequest>
    • Optional setDefault?: boolean
    • Optional tracksSource?: boolean
    \ No newline at end of file +SandboxRequestCacheEntry | @salesforce/core
    SandboxRequestCacheEntry: {
        action: "Create" | "Refresh";
        alias?: string;
        prodOrgUsername: string;
        sandboxProcessObject: Partial<SandboxProcessObject>;
        sandboxRequest: Partial<SandboxRequest>;
        setDefault?: boolean;
        tracksSource?: boolean;
    }

    Type declaration

    • action: "Create" | "Refresh"
    • Optional alias?: string
    • prodOrgUsername: string
    • sandboxProcessObject: Partial<SandboxProcessObject>
    • sandboxRequest: Partial<SandboxRequest>
    • Optional setDefault?: boolean
    • Optional tracksSource?: boolean
    \ No newline at end of file diff --git a/types/config_ttlConfig.TTLConfig.Contents.html b/types/config_ttlConfig.TTLConfig.Contents.html index a871e912f..1ab98b34b 100644 --- a/types/config_ttlConfig.TTLConfig.Contents.html +++ b/types/config_ttlConfig.TTLConfig.Contents.html @@ -1 +1 @@ -Contents | @salesforce/core
    Contents<T>: Record<string, Entry<T>>

    Type Parameters

    • T extends JsonMap
    \ No newline at end of file +Contents | @salesforce/core
    Contents<T>: Record<string, Entry<T>>

    Type Parameters

    • T extends JsonMap
    \ No newline at end of file diff --git a/types/config_ttlConfig.TTLConfig.Entry.html b/types/config_ttlConfig.TTLConfig.Entry.html index 74ac52705..440aca880 100644 --- a/types/config_ttlConfig.TTLConfig.Entry.html +++ b/types/config_ttlConfig.TTLConfig.Entry.html @@ -1 +1 @@ -Entry | @salesforce/core
    Entry<T>: T & {
        timestamp: string;
    }

    Type Parameters

    • T extends JsonMap

    Type declaration

    • timestamp: string
    \ No newline at end of file +Entry | @salesforce/core
    Entry<T>: T & {
        timestamp: string;
    }

    Type Parameters

    • T extends JsonMap

    Type declaration

    • timestamp: string
    \ No newline at end of file diff --git a/types/config_ttlConfig.TTLConfig.Options.html b/types/config_ttlConfig.TTLConfig.Options.html index 0b4581eeb..0b4ecea42 100644 --- a/types/config_ttlConfig.TTLConfig.Options.html +++ b/types/config_ttlConfig.TTLConfig.Options.html @@ -1 +1 @@ -Options | @salesforce/core
    Options: ConfigFile.Options & {
        ttl: Duration;
    }

    Type declaration

    • ttl: Duration
    \ No newline at end of file +Options | @salesforce/core
    Options: ConfigFile.Options & {
        ttl: Duration;
    }

    Type declaration

    • ttl: Duration
    \ No newline at end of file diff --git a/types/crypto_keyChainImpl.FsIfc.html b/types/crypto_keyChainImpl.FsIfc.html index ca4fc3a03..d8ff90956 100644 --- a/types/crypto_keyChainImpl.FsIfc.html +++ b/types/crypto_keyChainImpl.FsIfc.html @@ -1 +1 @@ -FsIfc | @salesforce/core
    FsIfc: Pick<typeof nodeFs, "statSync">
    \ No newline at end of file +FsIfc | @salesforce/core
    FsIfc: Pick<typeof nodeFs, "statSync">
    \ No newline at end of file diff --git a/types/crypto_keyChainImpl.KeyChain.html b/types/crypto_keyChainImpl.KeyChain.html index 5a57d97cd..0e803c1fb 100644 --- a/types/crypto_keyChainImpl.KeyChain.html +++ b/types/crypto_keyChainImpl.KeyChain.html @@ -1 +1 @@ -KeyChain | @salesforce/core
    KeyChain: GenericUnixKeychainAccess | GenericWindowsKeychainAccess | KeychainAccess
    \ No newline at end of file +KeyChain | @salesforce/core
    KeyChain: GenericUnixKeychainAccess | GenericWindowsKeychainAccess | KeychainAccess
    \ No newline at end of file diff --git a/types/crypto_keyChainImpl.PasswordStore.html b/types/crypto_keyChainImpl.PasswordStore.html index 45ee99407..258ab1f44 100644 --- a/types/crypto_keyChainImpl.PasswordStore.html +++ b/types/crypto_keyChainImpl.PasswordStore.html @@ -3,7 +3,7 @@

    Parameters

    • opts: ProgramOpts

      cli level password options.

    • fn: ((error, password?) => void)

      function callback for password.

        • (error, password?): void
        • Parameters

          • error: Nullable<Error>
          • Optional password: string

          Returns void

    • Optional retryCount: number

      number of reties to get the password.

      -

    Returns Promise<void>

  • setPassword:function
    • Sets a password.

      +
  • Returns Promise<void>

  • setPassword:function
    • Sets a password.

      Parameters

      • opts: ProgramOpts

        cli level password options.

      • fn: ((error, contents?) => void)

        function callback for password.

        -
          • (error, contents?): void
          • Parameters

            • error: Nullable<Error>
            • Optional contents: SecretContents

            Returns void

      Returns Promise<void>

  • \ No newline at end of file +
      • (error, contents?): void
      • Parameters

        • error: Nullable<Error>
        • Optional contents: SecretContents

        Returns void

    Returns Promise<void>

    \ No newline at end of file diff --git a/types/crypto_secureBuffer.DecipherCallback.html b/types/crypto_secureBuffer.DecipherCallback.html index 0f4604bda..64e3affe0 100644 --- a/types/crypto_secureBuffer.DecipherCallback.html +++ b/types/crypto_secureBuffer.DecipherCallback.html @@ -1,3 +1,3 @@ DecipherCallback | @salesforce/core
    DecipherCallback<T>: ((buffer) => T)

    Returns the intended type of the object to return. This is implementation specific.

    Type Parameters

    • T

    Type declaration

      • (buffer): T
      • Parameters

        • buffer: Buffer

          A buffer containing the decrypted secret.

          -

        Returns T

    \ No newline at end of file +

    Returns T

    \ No newline at end of file diff --git a/types/deviceOauthService.DeviceCodePollingResponse.html b/types/deviceOauthService.DeviceCodePollingResponse.html index 7fc9b21b9..563e2106d 100644 --- a/types/deviceOauthService.DeviceCodePollingResponse.html +++ b/types/deviceOauthService.DeviceCodePollingResponse.html @@ -1 +1 @@ -DeviceCodePollingResponse | @salesforce/core
    DeviceCodePollingResponse: {
        access_token: string;
        id: string;
        instance_url: string;
        issued_at: string;
        refresh_token: string;
        scope: string;
        signature: string;
        token_type: string;
    } & JsonMap

    Type declaration

    • access_token: string
    • id: string
    • instance_url: string
    • issued_at: string
    • refresh_token: string
    • scope: string
    • signature: string
    • token_type: string
    \ No newline at end of file +DeviceCodePollingResponse | @salesforce/core
    DeviceCodePollingResponse: {
        access_token: string;
        id: string;
        instance_url: string;
        issued_at: string;
        refresh_token: string;
        scope: string;
        signature: string;
        token_type: string;
    } & JsonMap

    Type declaration

    • access_token: string
    • id: string
    • instance_url: string
    • issued_at: string
    • refresh_token: string
    • scope: string
    • signature: string
    • token_type: string
    \ No newline at end of file diff --git a/types/deviceOauthService.DeviceCodeResponse.html b/types/deviceOauthService.DeviceCodeResponse.html index a7178e5ed..3f99fc1d8 100644 --- a/types/deviceOauthService.DeviceCodeResponse.html +++ b/types/deviceOauthService.DeviceCodeResponse.html @@ -1 +1 @@ -DeviceCodeResponse | @salesforce/core
    DeviceCodeResponse: {
        device_code: string;
        interval: number;
        user_code: string;
        verification_uri: string;
    } & JsonMap

    Type declaration

    • device_code: string
    • interval: number
    • user_code: string
    • verification_uri: string
    \ No newline at end of file +DeviceCodeResponse | @salesforce/core
    DeviceCodeResponse: {
        device_code: string;
        interval: number;
        user_code: string;
        verification_uri: string;
    } & JsonMap

    Type declaration

    • device_code: string
    • interval: number
    • user_code: string
    • verification_uri: string
    \ No newline at end of file diff --git a/types/lifecycleEvents.UniqueListenerMap.html b/types/lifecycleEvents.UniqueListenerMap.html index 0e194ef98..350806db6 100644 --- a/types/lifecycleEvents.UniqueListenerMap.html +++ b/types/lifecycleEvents.UniqueListenerMap.html @@ -1 +1 @@ -UniqueListenerMap | @salesforce/core
    UniqueListenerMap: Map<string, ListenerMap>
    \ No newline at end of file +UniqueListenerMap | @salesforce/core
    UniqueListenerMap: Map<string, ListenerMap>
    \ No newline at end of file diff --git a/types/lifecycleEvents.callback.html b/types/lifecycleEvents.callback.html index e564501f7..b5ea517a6 100644 --- a/types/lifecycleEvents.callback.html +++ b/types/lifecycleEvents.callback.html @@ -1 +1 @@ -callback | @salesforce/core
    callback: ((data) => Promise<void>)

    Type declaration

      • (data): Promise<void>
      • Parameters

        • data: any

        Returns Promise<void>

    \ No newline at end of file +callback | @salesforce/core
    callback: ((data) => Promise<void>)

    Type declaration

      • (data): Promise<void>
      • Parameters

        • data: any

        Returns Promise<void>

    \ No newline at end of file diff --git a/types/logger_logger.FieldValue.html b/types/logger_logger.FieldValue.html index c0b41176e..2fdc6816a 100644 --- a/types/logger_logger.FieldValue.html +++ b/types/logger_logger.FieldValue.html @@ -1,2 +1,2 @@ FieldValue | @salesforce/core
    FieldValue: string | number | boolean | Fields

    All possible field value types.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/logger_logger.Fields.html b/types/logger_logger.Fields.html index 8608a68fc..9ec3a297f 100644 --- a/types/logger_logger.Fields.html +++ b/types/logger_logger.Fields.html @@ -1,2 +1,2 @@ Fields | @salesforce/core
    Fields: Record<string, unknown>

    An object

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/logger_logger.LogLine.html b/types/logger_logger.LogLine.html index a933786ec..d4130d3ab 100644 --- a/types/logger_logger.LogLine.html +++ b/types/logger_logger.LogLine.html @@ -1,2 +1,2 @@ LogLine | @salesforce/core
    LogLine: {
        hostname: string;
        level: number;
        log: string;
        msg: string;
        name: string;
        pid: string;
        time: string;
        v: number;
    }

    Log line interface

    -

    Type declaration

    • hostname: string
    • level: number
    • log: string
    • msg: string
    • name: string
    • pid: string
    • time: string
    • v: number
    \ No newline at end of file +

    Type declaration

    • hostname: string
    • level: number
    • log: string
    • msg: string
    • name: string
    • pid: string
    • time: string
    • v: number
    \ No newline at end of file diff --git a/types/logger_logger.LoggerLevelValue.html b/types/logger_logger.LoggerLevelValue.html index 09ce1e4ba..9e99296c9 100644 --- a/types/logger_logger.LoggerLevelValue.html +++ b/types/logger_logger.LoggerLevelValue.html @@ -1,2 +1,2 @@ LoggerLevelValue | @salesforce/core
    LoggerLevelValue: LoggerLevel | number

    Any numeric Logger level.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/logger_logger.LoggerOptions.html b/types/logger_logger.LoggerOptions.html index 4e419335d..dd324beb9 100644 --- a/types/logger_logger.LoggerOptions.html +++ b/types/logger_logger.LoggerOptions.html @@ -3,4 +3,4 @@
  • Optional level?: LoggerLevelValue

    The desired log level.

  • name: string

    The logger name.

  • Optional useMemoryLogger?: boolean

    log to memory instead of to a file. Intended for Unit Testing

    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/messages.LoaderFunction.html b/types/messages.LoaderFunction.html index 9ae3722e8..56cd6888c 100644 --- a/types/messages.LoaderFunction.html +++ b/types/messages.LoaderFunction.html @@ -1,3 +1,3 @@ LoaderFunction | @salesforce/core

    Type alias LoaderFunction<T>

    LoaderFunction<T>: ((locale) => Messages<T>)

    A loader function to return messages.

    Type Parameters

    • T extends string

    Type declaration

      • (locale): Messages<T>
      • Parameters

        • locale: string

          The local set by the framework.

          -

        Returns Messages<T>

    \ No newline at end of file +

    Returns Messages<T>

    \ No newline at end of file diff --git a/types/messages.StoredMessage.html b/types/messages.StoredMessage.html index 4292506e1..46aaba429 100644 --- a/types/messages.StoredMessage.html +++ b/types/messages.StoredMessage.html @@ -1 +1 @@ -StoredMessage | @salesforce/core
    StoredMessage: string | string[] | {
        [s: string]: StoredMessage;
    }

    Type declaration

    \ No newline at end of file +StoredMessage | @salesforce/core
    StoredMessage: string | string[] | {
        [s: string]: StoredMessage;
    }

    Type declaration

    \ No newline at end of file diff --git a/types/messages.StoredMessageMap.html b/types/messages.StoredMessageMap.html index 592593b5b..23e95e07a 100644 --- a/types/messages.StoredMessageMap.html +++ b/types/messages.StoredMessageMap.html @@ -1 +1 @@ -StoredMessageMap | @salesforce/core

    Type alias StoredMessageMap

    StoredMessageMap: Map<string, StoredMessage>
    \ No newline at end of file +StoredMessageMap | @salesforce/core

    Type alias StoredMessageMap

    StoredMessageMap: Map<string, StoredMessage>
    \ No newline at end of file diff --git a/types/messages.StructuredMessage.html b/types/messages.StructuredMessage.html index b58b0ea7d..798737fbe 100644 --- a/types/messages.StructuredMessage.html +++ b/types/messages.StructuredMessage.html @@ -1 +1 @@ -StructuredMessage | @salesforce/core

    Type alias StructuredMessage

    StructuredMessage: {
        actions?: string[];
        message: string;
        name: string;
    }

    Type declaration

    • Optional actions?: string[]
    • message: string
    • name: string
    \ No newline at end of file +StructuredMessage | @salesforce/core

    Type alias StructuredMessage

    StructuredMessage: {
        actions?: string[];
        message: string;
        name: string;
    }

    Type declaration

    • Optional actions?: string[]
    • message: string
    • name: string
    \ No newline at end of file diff --git a/types/messages.Tokens.html b/types/messages.Tokens.html index 78069f999..2b0d7139e 100644 --- a/types/messages.Tokens.html +++ b/types/messages.Tokens.html @@ -1 +1 @@ -Tokens | @salesforce/core
    Tokens: (string | boolean | number | null | undefined)[]
    \ No newline at end of file +Tokens | @salesforce/core
    Tokens: (string | boolean | number | null | undefined)[]
    \ No newline at end of file diff --git a/types/org_authInfo.AccessTokenOptions.html b/types/org_authInfo.AccessTokenOptions.html index b9d44d771..c9eba708e 100644 --- a/types/org_authInfo.AccessTokenOptions.html +++ b/types/org_authInfo.AccessTokenOptions.html @@ -1,2 +1,2 @@ AccessTokenOptions | @salesforce/core
    AccessTokenOptions: {
        accessToken?: string;
        instanceUrl?: string;
        loginUrl?: string;
    }

    Options for access token flow.

    -

    Type declaration

    • Optional accessToken?: string
    • Optional instanceUrl?: string
    • Optional loginUrl?: string
    \ No newline at end of file +

    Type declaration

    • Optional accessToken?: string
    • Optional instanceUrl?: string
    • Optional loginUrl?: string
    \ No newline at end of file diff --git a/types/org_authInfo.AuthFields.html b/types/org_authInfo.AuthFields.html index 7d47a83f8..d57cfb169 100644 --- a/types/org_authInfo.AuthFields.html +++ b/types/org_authInfo.AuthFields.html @@ -1,2 +1,2 @@ AuthFields | @salesforce/core
    AuthFields: {
        accessToken?: string;
        alias?: string;
        authCode?: string;
        clientId?: string;
        clientSecret?: string;
        created?: string;
        createdOrgInstance?: string;
        devHubUsername?: string;
        expirationDate?: string;
        instanceApiVersion?: string;
        instanceApiVersionLastRetrieved?: string;
        instanceName?: string;
        instanceUrl?: string;
        isDevHub?: boolean;
        isSandbox?: boolean;
        isScratch?: boolean;
        loginUrl?: string;
        name?: string;
        namespacePrefix?: Nullable<string>;
        orgId?: string;
        password?: string;
        privateKey?: string;
        refreshToken?: string;
        scratchAdminUsername?: string;
        snapshot?: string;
        tracksSource?: boolean;
        trailExpirationDate?: Nullable<string>;
        userId?: string;
        userProfileName?: string;
        username?: string;
        usernames?: string[];
    }

    Fields for authorization, org, and local information.

    -

    Type declaration

    • Optional accessToken?: string
    • Optional alias?: string
    • Optional authCode?: string
    • Optional clientId?: string
    • Optional clientSecret?: string
    • Optional created?: string
    • Optional createdOrgInstance?: string
    • Optional devHubUsername?: string
    • Optional expirationDate?: string
    • Optional instanceApiVersion?: string
    • Optional instanceApiVersionLastRetrieved?: string
    • Optional instanceName?: string
    • Optional instanceUrl?: string
    • Optional isDevHub?: boolean
    • Optional isSandbox?: boolean
    • Optional isScratch?: boolean
    • Optional loginUrl?: string
    • Optional name?: string
    • Optional namespacePrefix?: Nullable<string>
    • Optional orgId?: string
    • Optional password?: string
    • Optional privateKey?: string
    • Optional refreshToken?: string
    • Optional scratchAdminUsername?: string
    • Optional snapshot?: string
    • Optional tracksSource?: boolean
    • Optional trailExpirationDate?: Nullable<string>
    • Optional userId?: string
    • Optional userProfileName?: string
    • Optional username?: string
    • Optional usernames?: string[]
    \ No newline at end of file +

    Type declaration

    • Optional accessToken?: string
    • Optional alias?: string
    • Optional authCode?: string
    • Optional clientId?: string
    • Optional clientSecret?: string
    • Optional created?: string
    • Optional createdOrgInstance?: string
    • Optional devHubUsername?: string
    • Optional expirationDate?: string
    • Optional instanceApiVersion?: string
    • Optional instanceApiVersionLastRetrieved?: string
    • Optional instanceName?: string
    • Optional instanceUrl?: string
    • Optional isDevHub?: boolean
    • Optional isSandbox?: boolean
    • Optional isScratch?: boolean
    • Optional loginUrl?: string
    • Optional name?: string
    • Optional namespacePrefix?: Nullable<string>
    • Optional orgId?: string
    • Optional password?: string
    • Optional privateKey?: string
    • Optional refreshToken?: string
    • Optional scratchAdminUsername?: string
    • Optional snapshot?: string
    • Optional tracksSource?: boolean
    • Optional trailExpirationDate?: Nullable<string>
    • Optional userId?: string
    • Optional userProfileName?: string
    • Optional username?: string
    • Optional usernames?: string[]
    \ No newline at end of file diff --git a/types/org_authInfo.AuthInfo.Options.html b/types/org_authInfo.AuthInfo.Options.html index ca2a37dff..030343cc6 100644 --- a/types/org_authInfo.AuthInfo.Options.html +++ b/types/org_authInfo.AuthInfo.Options.html @@ -5,4 +5,4 @@ information from another parent org. Typically for scratch org or sandbox creation.

  • Optional username?: string

    Org signup username.

    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/org_authInfo.AuthSideEffects.html b/types/org_authInfo.AuthSideEffects.html index fa0d8a759..4d8d939eb 100644 --- a/types/org_authInfo.AuthSideEffects.html +++ b/types/org_authInfo.AuthSideEffects.html @@ -1 +1 @@ -AuthSideEffects | @salesforce/core
    AuthSideEffects: {
        alias?: string;
        setDefault: boolean;
        setDefaultDevHub: boolean;
        setTracksSource?: boolean;
    }

    Type declaration

    • Optional alias?: string
    • setDefault: boolean
    • setDefaultDevHub: boolean
    • Optional setTracksSource?: boolean
    \ No newline at end of file +AuthSideEffects | @salesforce/core
    AuthSideEffects: {
        alias?: string;
        setDefault: boolean;
        setDefaultDevHub: boolean;
        setTracksSource?: boolean;
    }

    Type declaration

    • Optional alias?: string
    • setDefault: boolean
    • setDefaultDevHub: boolean
    • Optional setTracksSource?: boolean
    \ No newline at end of file diff --git a/types/org_authInfo.ConnectionOptions.html b/types/org_authInfo.ConnectionOptions.html index 49e93d57f..6cff630bb 100644 --- a/types/org_authInfo.ConnectionOptions.html +++ b/types/org_authInfo.ConnectionOptions.html @@ -1,4 +1,4 @@ ConnectionOptions | @salesforce/core
    ConnectionOptions: AuthFields & {
        oauth2?: Partial<JwtOAuth2Config>;
        refreshFn?: RefreshFn;
    }

    Options for Connection.

    Type declaration

    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/org_authInfo.JwtOAuth2Config.html b/types/org_authInfo.JwtOAuth2Config.html index e911c9872..33dcfcf7e 100644 --- a/types/org_authInfo.JwtOAuth2Config.html +++ b/types/org_authInfo.JwtOAuth2Config.html @@ -1 +1 @@ -JwtOAuth2Config | @salesforce/core
    JwtOAuth2Config: OAuth2Config & {
        authCode?: string;
        privateKey?: string;
        privateKeyFile?: string;
        refreshToken?: string;
        username?: string;
    }

    Type declaration

    • Optional authCode?: string
    • Optional privateKey?: string
    • Optional privateKeyFile?: string
    • Optional refreshToken?: string
    • Optional username?: string
    \ No newline at end of file +JwtOAuth2Config | @salesforce/core
    JwtOAuth2Config: OAuth2Config & {
        authCode?: string;
        privateKey?: string;
        privateKeyFile?: string;
        refreshToken?: string;
        username?: string;
    }

    Type declaration

    • Optional authCode?: string
    • Optional privateKey?: string
    • Optional privateKeyFile?: string
    • Optional refreshToken?: string
    • Optional username?: string
    \ No newline at end of file diff --git a/types/org_authInfo.OrgAuthorization.html b/types/org_authInfo.OrgAuthorization.html index 3d20f47e3..c97882c55 100644 --- a/types/org_authInfo.OrgAuthorization.html +++ b/types/org_authInfo.OrgAuthorization.html @@ -1 +1 @@ -OrgAuthorization | @salesforce/core
    OrgAuthorization: {
        accessToken?: string;
        aliases: Nullable<string[]>;
        configs: Nullable<string[]>;
        error?: string;
        instanceUrl?: string;
        isDevHub?: boolean;
        isExpired: boolean | "unknown";
        isSandbox?: boolean;
        isScratchOrg?: boolean;
        oauthMethod: "jwt" | "web" | "token" | "unknown";
        orgId: string;
        username: string;
    }

    Type declaration

    • Optional accessToken?: string
    • aliases: Nullable<string[]>
    • configs: Nullable<string[]>
    • Optional error?: string
    • Optional instanceUrl?: string
    • Optional isDevHub?: boolean
    • isExpired: boolean | "unknown"
    • Optional isSandbox?: boolean
    • Optional isScratchOrg?: boolean
    • oauthMethod: "jwt" | "web" | "token" | "unknown"
    • orgId: string
    • username: string
    \ No newline at end of file +OrgAuthorization | @salesforce/core
    OrgAuthorization: {
        accessToken?: string;
        aliases: Nullable<string[]>;
        configs: Nullable<string[]>;
        error?: string;
        instanceUrl?: string;
        isDevHub?: boolean;
        isExpired: boolean | "unknown";
        isSandbox?: boolean;
        isScratchOrg?: boolean;
        oauthMethod: "jwt" | "web" | "token" | "unknown";
        orgId: string;
        username: string;
    }

    Type declaration

    • Optional accessToken?: string
    • aliases: Nullable<string[]>
    • configs: Nullable<string[]>
    • Optional error?: string
    • Optional instanceUrl?: string
    • Optional isDevHub?: boolean
    • isExpired: boolean | "unknown"
    • Optional isSandbox?: boolean
    • Optional isScratchOrg?: boolean
    • oauthMethod: "jwt" | "web" | "token" | "unknown"
    • orgId: string
    • username: string
    \ No newline at end of file diff --git a/types/org_authInfo.RefreshFn.html b/types/org_authInfo.RefreshFn.html index 5521b9cf5..506e5ef18 100644 --- a/types/org_authInfo.RefreshFn.html +++ b/types/org_authInfo.RefreshFn.html @@ -1,2 +1,2 @@ RefreshFn | @salesforce/core
    RefreshFn: ((conn, callback) => Promise<void>)

    A function to update a refresh token when the access token is expired.

    -

    Type declaration

      • (conn, callback): Promise<void>
      • Parameters

        • conn: Connection
        • callback: ((err, accessToken?, res?) => Promise<void>)
            • (err, accessToken?, res?): Promise<void>
            • Parameters

              • err: Nullable<Error>
              • Optional accessToken: string
              • Optional res: Record<string, unknown>

              Returns Promise<void>

        Returns Promise<void>

    \ No newline at end of file +

    Type declaration

      • (conn, callback): Promise<void>
      • Parameters

        • conn: Connection
        • callback: ((err, accessToken?, res?) => Promise<void>)
            • (err, accessToken?, res?): Promise<void>
            • Parameters

              • err: Nullable<Error>
              • Optional accessToken: string
              • Optional res: Record<string, unknown>

              Returns Promise<void>

        Returns Promise<void>

    \ No newline at end of file diff --git a/types/org_connection.Connection.Options.html b/types/org_connection.Connection.Options.html index c2ce8b664..19f99f007 100644 --- a/types/org_connection.Connection.Options.html +++ b/types/org_connection.Connection.Options.html @@ -2,4 +2,4 @@

    Type Parameters

    • S extends Schema

    Type declaration

    • authInfo: AuthInfo

      AuthInfo instance.

    • Optional configAggregator?: ConfigAggregator

      ConfigAggregator for getting defaults.

    • Optional connectionOptions?: ConnectionConfig<S>

      Additional connection parameters.

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/org_connection.DeployOptionsWithRest.html b/types/org_connection.DeployOptionsWithRest.html index 8c3b2a41b..7cdf663f4 100644 --- a/types/org_connection.DeployOptionsWithRest.html +++ b/types/org_connection.DeployOptionsWithRest.html @@ -1 +1 @@ -DeployOptionsWithRest | @salesforce/core
    DeployOptionsWithRest: Partial<DeployOptions> & {
        rest?: boolean;
    }

    Type declaration

    • Optional rest?: boolean
    \ No newline at end of file +DeployOptionsWithRest | @salesforce/core
    DeployOptionsWithRest: Partial<DeployOptions> & {
        rest?: boolean;
    }

    Type declaration

    • Optional rest?: boolean
    \ No newline at end of file diff --git a/types/org_connection.SingleRecordQueryOptions.html b/types/org_connection.SingleRecordQueryOptions.html index 8bdfb51d3..d14bf176c 100644 --- a/types/org_connection.SingleRecordQueryOptions.html +++ b/types/org_connection.SingleRecordQueryOptions.html @@ -1 +1 @@ -SingleRecordQueryOptions | @salesforce/core
    SingleRecordQueryOptions: {
        choiceField?: string;
        returnChoicesOnMultiple?: boolean;
        tooling?: boolean;
    }

    Type declaration

    • Optional choiceField?: string
    • Optional returnChoicesOnMultiple?: boolean
    • Optional tooling?: boolean
    \ No newline at end of file +SingleRecordQueryOptions | @salesforce/core
    SingleRecordQueryOptions: {
        choiceField?: string;
        returnChoicesOnMultiple?: boolean;
        tooling?: boolean;
    }

    Type declaration

    • Optional choiceField?: string
    • Optional returnChoicesOnMultiple?: boolean
    • Optional tooling?: boolean
    \ No newline at end of file diff --git a/types/org_org.Org.Options.html b/types/org_org.Org.Options.html index 21365ecac..4af3ab728 100644 --- a/types/org_org.Org.Options.html +++ b/types/org_org.Org.Options.html @@ -1,2 +1,2 @@ Options | @salesforce/core
    Options: {
        aggregator?: ConfigAggregator;
        aliasOrUsername?: string;
        connection?: Connection;
        isDevHub?: boolean;
    }

    Constructor Options for and Org.

    -

    Type declaration

    • Optional aggregator?: ConfigAggregator
    • Optional aliasOrUsername?: string
    • Optional connection?: Connection
    • Optional isDevHub?: boolean
    \ No newline at end of file +

    Type declaration

    • Optional aggregator?: ConfigAggregator
    • Optional aliasOrUsername?: string
    • Optional connection?: Connection
    • Optional isDevHub?: boolean
    \ No newline at end of file diff --git a/types/org_org.OrganizationInformation.html b/types/org_org.OrganizationInformation.html index 59868d3b3..6e85feb50 100644 --- a/types/org_org.OrganizationInformation.html +++ b/types/org_org.OrganizationInformation.html @@ -1 +1 @@ -OrganizationInformation | @salesforce/core

    Type alias OrganizationInformation

    OrganizationInformation: {
        InstanceName: string;
        IsSandbox: boolean;
        Name: string;
        NamespacePrefix: string | null;
        TrialExpirationDate: string | null;
    }

    Type declaration

    • InstanceName: string
    • IsSandbox: boolean
    • Name: string
    • NamespacePrefix: string | null
    • TrialExpirationDate: string | null
    \ No newline at end of file +OrganizationInformation | @salesforce/core

    Type alias OrganizationInformation

    OrganizationInformation: {
        InstanceName: string;
        IsSandbox: boolean;
        Name: string;
        NamespacePrefix: string | null;
        TrialExpirationDate: string | null;
    }

    Type declaration

    • InstanceName: string
    • IsSandbox: boolean
    • Name: string
    • NamespacePrefix: string | null
    • TrialExpirationDate: string | null
    \ No newline at end of file diff --git a/types/org_org.ResultEvent.html b/types/org_org.ResultEvent.html index 0752d44cb..35e4a3149 100644 --- a/types/org_org.ResultEvent.html +++ b/types/org_org.ResultEvent.html @@ -1 +1 @@ -ResultEvent | @salesforce/core
    ResultEvent: {
        sandboxProcessObj: SandboxProcessObject;
        sandboxRes: SandboxUserAuthResponse;
    }

    Type declaration

    \ No newline at end of file +ResultEvent | @salesforce/core
    ResultEvent: {
        sandboxProcessObj: SandboxProcessObject;
        sandboxRes: SandboxUserAuthResponse;
    }

    Type declaration

    \ No newline at end of file diff --git a/types/org_org.ResumeSandboxRequest.html b/types/org_org.ResumeSandboxRequest.html index c0334d06d..9b63a45a6 100644 --- a/types/org_org.ResumeSandboxRequest.html +++ b/types/org_org.ResumeSandboxRequest.html @@ -1 +1 @@ -ResumeSandboxRequest | @salesforce/core

    Type alias ResumeSandboxRequest

    ResumeSandboxRequest: {
        SandboxName?: string;
        SandboxProcessObjId?: string;
    }

    Type declaration

    • Optional SandboxName?: string
    • Optional SandboxProcessObjId?: string
    \ No newline at end of file +ResumeSandboxRequest | @salesforce/core

    Type alias ResumeSandboxRequest

    ResumeSandboxRequest: {
        SandboxName?: string;
        SandboxProcessObjId?: string;
    }

    Type declaration

    • Optional SandboxName?: string
    • Optional SandboxProcessObjId?: string
    \ No newline at end of file diff --git a/types/org_org.SandboxFields.html b/types/org_org.SandboxFields.html index c58800248..d2a0d33fd 100644 --- a/types/org_org.SandboxFields.html +++ b/types/org_org.SandboxFields.html @@ -1 +1 @@ -SandboxFields | @salesforce/core

    Type alias SandboxFields

    SandboxFields: {
        prodOrgUsername: string;
        sandboxInfoId?: string;
        sandboxName?: string;
        sandboxOrgId: string;
        sandboxProcessId?: string;
        sandboxUsername?: string;
        timestamp?: string;
    }

    Type declaration

    • prodOrgUsername: string
    • Optional sandboxInfoId?: string
    • Optional sandboxName?: string
    • sandboxOrgId: string
    • Optional sandboxProcessId?: string
    • Optional sandboxUsername?: string
    • Optional timestamp?: string
    \ No newline at end of file +SandboxFields | @salesforce/core

    Type alias SandboxFields

    SandboxFields: {
        prodOrgUsername: string;
        sandboxInfoId?: string;
        sandboxName?: string;
        sandboxOrgId: string;
        sandboxProcessId?: string;
        sandboxUsername?: string;
        timestamp?: string;
    }

    Type declaration

    • prodOrgUsername: string
    • Optional sandboxInfoId?: string
    • Optional sandboxName?: string
    • sandboxOrgId: string
    • Optional sandboxProcessId?: string
    • Optional sandboxUsername?: string
    • Optional timestamp?: string
    \ No newline at end of file diff --git a/types/org_org.SandboxInfo.html b/types/org_org.SandboxInfo.html index 14e62c1c0..26a214681 100644 --- a/types/org_org.SandboxInfo.html +++ b/types/org_org.SandboxInfo.html @@ -1 +1 @@ -SandboxInfo | @salesforce/core
    SandboxInfo: {
        ActivationUserGroupId?: string;
        ApexClassId?: string;
        AutoActivate: boolean;
        CopyArchivedActivities?: boolean;
        CopyChatter: boolean;
        CreatedById: string;
        CreatedDate: string;
        Description?: string;
        HistoryDays: -1 | 0 | 10 | 20 | 30 | 60 | 90 | 120 | 150 | 180;
        Id: string;
        IsDeleted: boolean;
        LastModifiedById: string;
        LastModifiedDate: string;
        LicenseType: "DEVELOPER" | "DEVELOPER PRO" | "PARTIAL" | "FULL";
        SandboxName: string;
        SourceId?: string;
        TemplateId?: string;
    }

    Type declaration

    • Optional ActivationUserGroupId?: string
    • Optional ApexClassId?: string
    • AutoActivate: boolean
    • Optional CopyArchivedActivities?: boolean
    • CopyChatter: boolean
    • CreatedById: string
    • CreatedDate: string
    • Optional Description?: string
    • HistoryDays: -1 | 0 | 10 | 20 | 30 | 60 | 90 | 120 | 150 | 180
    • Id: string
    • IsDeleted: boolean
    • LastModifiedById: string
    • LastModifiedDate: string
    • LicenseType: "DEVELOPER" | "DEVELOPER PRO" | "PARTIAL" | "FULL"
    • SandboxName: string
    • Optional SourceId?: string
    • Optional TemplateId?: string
    \ No newline at end of file +SandboxInfo | @salesforce/core
    SandboxInfo: {
        ActivationUserGroupId?: string;
        ApexClassId?: string;
        AutoActivate: boolean;
        CopyArchivedActivities?: boolean;
        CopyChatter: boolean;
        CreatedById: string;
        CreatedDate: string;
        Description?: string;
        HistoryDays: -1 | 0 | 10 | 20 | 30 | 60 | 90 | 120 | 150 | 180;
        Id: string;
        IsDeleted: boolean;
        LastModifiedById: string;
        LastModifiedDate: string;
        LicenseType: "DEVELOPER" | "DEVELOPER PRO" | "PARTIAL" | "FULL";
        SandboxName: string;
        SourceId?: string;
        TemplateId?: string;
    }

    Type declaration

    • Optional ActivationUserGroupId?: string
    • Optional ApexClassId?: string
    • AutoActivate: boolean
    • Optional CopyArchivedActivities?: boolean
    • CopyChatter: boolean
    • CreatedById: string
    • CreatedDate: string
    • Optional Description?: string
    • HistoryDays: -1 | 0 | 10 | 20 | 30 | 60 | 90 | 120 | 150 | 180
    • Id: string
    • IsDeleted: boolean
    • LastModifiedById: string
    • LastModifiedDate: string
    • LicenseType: "DEVELOPER" | "DEVELOPER PRO" | "PARTIAL" | "FULL"
    • SandboxName: string
    • Optional SourceId?: string
    • Optional TemplateId?: string
    \ No newline at end of file diff --git a/types/org_org.SandboxProcessObject.html b/types/org_org.SandboxProcessObject.html index fd94b64ae..a08dc00fa 100644 --- a/types/org_org.SandboxProcessObject.html +++ b/types/org_org.SandboxProcessObject.html @@ -1 +1 @@ -SandboxProcessObject | @salesforce/core

    Type alias SandboxProcessObject

    SandboxProcessObject: {
        ApexClassId?: string;
        CopyProgress?: number;
        CreatedDate: string;
        Description?: string;
        EndDate?: string;
        Id: string;
        LicenseType: string;
        SandboxInfoId: string;
        SandboxName: string;
        SandboxOrganization?: string;
        SourceId?: string;
        Status: string;
    }

    Type declaration

    • Optional ApexClassId?: string
    • Optional CopyProgress?: number
    • CreatedDate: string
    • Optional Description?: string
    • Optional EndDate?: string
    • Id: string
    • LicenseType: string
    • SandboxInfoId: string
    • SandboxName: string
    • Optional SandboxOrganization?: string
    • Optional SourceId?: string
    • Status: string
    \ No newline at end of file +SandboxProcessObject | @salesforce/core

    Type alias SandboxProcessObject

    SandboxProcessObject: {
        ApexClassId?: string;
        CopyProgress?: number;
        CreatedDate: string;
        Description?: string;
        EndDate?: string;
        Id: string;
        LicenseType: string;
        SandboxInfoId: string;
        SandboxName: string;
        SandboxOrganization?: string;
        SourceId?: string;
        Status: string;
    }

    Type declaration

    • Optional ApexClassId?: string
    • Optional CopyProgress?: number
    • CreatedDate: string
    • Optional Description?: string
    • Optional EndDate?: string
    • Id: string
    • LicenseType: string
    • SandboxInfoId: string
    • SandboxName: string
    • Optional SandboxOrganization?: string
    • Optional SourceId?: string
    • Status: string
    \ No newline at end of file diff --git a/types/org_org.SandboxRequest.html b/types/org_org.SandboxRequest.html index 612a914db..4b88b7997 100644 --- a/types/org_org.SandboxRequest.html +++ b/types/org_org.SandboxRequest.html @@ -1,2 +1,2 @@ SandboxRequest | @salesforce/core

    Type alias SandboxRequest

    SandboxRequest: {
        ActivationUserGroupId?: string;
        ApexClassId?: string;
        Description?: string;
        LicenseType?: string;
        SandboxName: string;
        SourceId?: string;
    }

    Type declaration

    • Optional ActivationUserGroupId?: string
    • Optional ApexClassId?: string
    • Optional Description?: string
    • Optional LicenseType?: string
    • SandboxName: string
    • Optional SourceId?: string

      Should match a SandboxInfoId, not a SandboxProcessId

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/org_org.SandboxUserAuthRequest.html b/types/org_org.SandboxUserAuthRequest.html index 4d45f2976..3a981919e 100644 --- a/types/org_org.SandboxUserAuthRequest.html +++ b/types/org_org.SandboxUserAuthRequest.html @@ -1 +1 @@ -SandboxUserAuthRequest | @salesforce/core

    Type alias SandboxUserAuthRequest

    SandboxUserAuthRequest: {
        callbackUrl: string;
        clientId: string;
        sandboxName: string;
    }

    Type declaration

    • callbackUrl: string
    • clientId: string
    • sandboxName: string
    \ No newline at end of file +SandboxUserAuthRequest | @salesforce/core

    Type alias SandboxUserAuthRequest

    SandboxUserAuthRequest: {
        callbackUrl: string;
        clientId: string;
        sandboxName: string;
    }

    Type declaration

    • callbackUrl: string
    • clientId: string
    • sandboxName: string
    \ No newline at end of file diff --git a/types/org_org.SandboxUserAuthResponse.html b/types/org_org.SandboxUserAuthResponse.html index 15b4b43d3..2b54047b6 100644 --- a/types/org_org.SandboxUserAuthResponse.html +++ b/types/org_org.SandboxUserAuthResponse.html @@ -1 +1 @@ -SandboxUserAuthResponse | @salesforce/core

    Type alias SandboxUserAuthResponse

    SandboxUserAuthResponse: {
        authCode: string;
        authUserName: string;
        instanceUrl: string;
        loginUrl: string;
    }

    Type declaration

    • authCode: string
    • authUserName: string
    • instanceUrl: string
    • loginUrl: string
    \ No newline at end of file +SandboxUserAuthResponse | @salesforce/core

    Type alias SandboxUserAuthResponse

    SandboxUserAuthResponse: {
        authCode: string;
        authUserName: string;
        instanceUrl: string;
        loginUrl: string;
    }

    Type declaration

    • authCode: string
    • authUserName: string
    • instanceUrl: string
    • loginUrl: string
    \ No newline at end of file diff --git a/types/org_org.ScratchOrgRequest.html b/types/org_org.ScratchOrgRequest.html index 64f577897..54a37c0a8 100644 --- a/types/org_org.ScratchOrgRequest.html +++ b/types/org_org.ScratchOrgRequest.html @@ -1 +1 @@ -ScratchOrgRequest | @salesforce/core

    Type alias ScratchOrgRequest

    ScratchOrgRequest: Omit<ScratchOrgCreateOptions, "hubOrg">
    \ No newline at end of file +ScratchOrgRequest | @salesforce/core

    Type alias ScratchOrgRequest

    ScratchOrgRequest: Omit<ScratchOrgCreateOptions, "hubOrg">
    \ No newline at end of file diff --git a/types/org_org.StatusEvent.html b/types/org_org.StatusEvent.html index adc52059f..35469c230 100644 --- a/types/org_org.StatusEvent.html +++ b/types/org_org.StatusEvent.html @@ -1 +1 @@ -StatusEvent | @salesforce/core
    StatusEvent: {
        interval: number;
        remainingWait: number;
        sandboxProcessObj: SandboxProcessObject;
        waitingOnAuth: boolean;
    }

    Type declaration

    \ No newline at end of file +StatusEvent | @salesforce/core
    StatusEvent: {
        interval: number;
        remainingWait: number;
        sandboxProcessObj: SandboxProcessObject;
        waitingOnAuth: boolean;
    }

    Type declaration

    \ No newline at end of file diff --git a/types/org_permissionSetAssignment.PermissionSetAssignmentFields.html b/types/org_permissionSetAssignment.PermissionSetAssignmentFields.html index dc3107649..f5a701c7c 100644 --- a/types/org_permissionSetAssignment.PermissionSetAssignmentFields.html +++ b/types/org_permissionSetAssignment.PermissionSetAssignmentFields.html @@ -1,2 +1,2 @@ PermissionSetAssignmentFields | @salesforce/core
    PermissionSetAssignmentFields: {
        assigneeId: string;
        permissionSetId: string;
    }

    Map of fields name for a permission set assignment

    -

    Type declaration

    • assigneeId: string
    • permissionSetId: string
    \ No newline at end of file +

    Type declaration

    • assigneeId: string
    • permissionSetId: string
    \ No newline at end of file diff --git a/types/org_scratchOrgCache.CachedOptions.html b/types/org_scratchOrgCache.CachedOptions.html index 78f526621..9e6171225 100644 --- a/types/org_scratchOrgCache.CachedOptions.html +++ b/types/org_scratchOrgCache.CachedOptions.html @@ -1,3 +1,3 @@ CachedOptions | @salesforce/core
    CachedOptions: {
        alias?: string;
        apiVersion?: string;
        clientSecret?: string;
        definitionjson: JsonMap;
        hubBaseUrl: string;
        hubUsername: string;
        setDefault?: boolean;
        signupTargetLoginUrlConfig?: string;
        tracksSource?: boolean;
    }

    Type declaration

    • Optional alias?: string
    • Optional apiVersion?: string
    • Optional clientSecret?: string

      may be required for auth

    • definitionjson: JsonMap

      stores the scratch definition, including settings/objectSettings

      -
    • hubBaseUrl: string
    • hubUsername: string
    • Optional setDefault?: boolean
    • Optional signupTargetLoginUrlConfig?: string
    • Optional tracksSource?: boolean
    \ No newline at end of file +
  • hubBaseUrl: string
  • hubUsername: string
  • Optional setDefault?: boolean
  • Optional signupTargetLoginUrlConfig?: string
  • Optional tracksSource?: boolean
  • \ No newline at end of file diff --git a/types/org_scratchOrgCreate.ScratchOrgCreateOptions.html b/types/org_scratchOrgCreate.ScratchOrgCreateOptions.html index cb4de3197..86e04819c 100644 --- a/types/org_scratchOrgCreate.ScratchOrgCreateOptions.html +++ b/types/org_scratchOrgCreate.ScratchOrgCreateOptions.html @@ -15,4 +15,4 @@
  • Optional setDefault?: boolean

    after complete, set the org as the default

  • Optional tracksSource?: boolean

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

  • Optional wait?: Duration

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

    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/org_scratchOrgCreate.ScratchOrgCreateResult.html b/types/org_scratchOrgCreate.ScratchOrgCreateResult.html index f0677ecc7..523e78bf7 100644 --- a/types/org_scratchOrgCreate.ScratchOrgCreateResult.html +++ b/types/org_scratchOrgCreate.ScratchOrgCreateResult.html @@ -1 +1 @@ -ScratchOrgCreateResult | @salesforce/core
    ScratchOrgCreateResult: {
        authFields?: AuthFields;
        authInfo?: AuthInfo;
        scratchOrgInfo?: ScratchOrgInfo;
        username?: string;
        warnings: string[];
    }

    Type declaration

    \ No newline at end of file +ScratchOrgCreateResult | @salesforce/core
    ScratchOrgCreateResult: {
        authFields?: AuthFields;
        authInfo?: AuthInfo;
        scratchOrgInfo?: ScratchOrgInfo;
        username?: string;
        warnings: string[];
    }

    Type declaration

    \ No newline at end of file diff --git a/types/org_scratchOrgInfoGenerator.ScratchOrgInfoPayload.html b/types/org_scratchOrgInfoGenerator.ScratchOrgInfoPayload.html index e6cb0b7ed..491df2681 100644 --- a/types/org_scratchOrgInfoGenerator.ScratchOrgInfoPayload.html +++ b/types/org_scratchOrgInfoGenerator.ScratchOrgInfoPayload.html @@ -1 +1 @@ -ScratchOrgInfoPayload | @salesforce/core
    ScratchOrgInfoPayload: {
        connectedAppCallbackUrl: string;
        connectedAppConsumerKey: string;
        durationDays: number;
        features: string | string[];
        namespace?: string;
        orgName: string;
        package2AncestorIds: string;
    } & PartialScratchOrgInfo

    Type declaration

    • connectedAppCallbackUrl: string
    • connectedAppConsumerKey: string
    • durationDays: number
    • features: string | string[]
    • Optional namespace?: string
    • orgName: string
    • package2AncestorIds: string
    \ No newline at end of file +ScratchOrgInfoPayload | @salesforce/core
    ScratchOrgInfoPayload: {
        connectedAppCallbackUrl: string;
        connectedAppConsumerKey: string;
        durationDays: number;
        features: string | string[];
        namespace?: string;
        orgName: string;
        package2AncestorIds: string;
    } & PartialScratchOrgInfo

    Type declaration

    • connectedAppCallbackUrl: string
    • connectedAppConsumerKey: string
    • durationDays: number
    • features: string | string[]
    • Optional namespace?: string
    • orgName: string
    • package2AncestorIds: string
    \ No newline at end of file diff --git a/types/org_scratchOrgLifecycleEvents.ScratchOrgLifecycleEvent.html b/types/org_scratchOrgLifecycleEvents.ScratchOrgLifecycleEvent.html index e00ea8a0b..35b3f50c8 100644 --- a/types/org_scratchOrgLifecycleEvents.ScratchOrgLifecycleEvent.html +++ b/types/org_scratchOrgLifecycleEvents.ScratchOrgLifecycleEvent.html @@ -1 +1 @@ -ScratchOrgLifecycleEvent | @salesforce/core
    ScratchOrgLifecycleEvent: {
        scratchOrgInfo?: ScratchOrgInfo;
        stage: typeof scratchOrgLifecycleStages[number];
    }

    Type declaration

    \ No newline at end of file +ScratchOrgLifecycleEvent | @salesforce/core
    ScratchOrgLifecycleEvent: {
        scratchOrgInfo?: ScratchOrgInfo;
        stage: typeof scratchOrgLifecycleStages[number];
    }

    Type declaration

    \ No newline at end of file diff --git a/types/org_scratchOrgSettingsGenerator.PackageFile.html b/types/org_scratchOrgSettingsGenerator.PackageFile.html index 1aaff6062..91440531c 100644 --- a/types/org_scratchOrgSettingsGenerator.PackageFile.html +++ b/types/org_scratchOrgSettingsGenerator.PackageFile.html @@ -1 +1 @@ -PackageFile | @salesforce/core
    PackageFile: {
        @: {
            xmlns: string;
        };
        types: SettingType[];
        version: string;
    }

    Type declaration

    • @: {
          xmlns: string;
      }
      • xmlns: string
    • types: SettingType[]
    • version: string
    \ No newline at end of file +PackageFile | @salesforce/core
    PackageFile: {
        @: {
            xmlns: string;
        };
        types: SettingType[];
        version: string;
    }

    Type declaration

    • @: {
          xmlns: string;
      }
      • xmlns: string
    • types: SettingType[]
    • version: string
    \ No newline at end of file diff --git a/types/org_scratchOrgSettingsGenerator.SettingType.html b/types/org_scratchOrgSettingsGenerator.SettingType.html index d17f94fe9..30b829b87 100644 --- a/types/org_scratchOrgSettingsGenerator.SettingType.html +++ b/types/org_scratchOrgSettingsGenerator.SettingType.html @@ -1 +1 @@ -SettingType | @salesforce/core
    SettingType: {
        members: string[];
        name: "CustomObject" | "RecordType" | "BusinessProcess" | "Settings";
    }

    Type declaration

    • members: string[]
    • name: "CustomObject" | "RecordType" | "BusinessProcess" | "Settings"
    \ No newline at end of file +SettingType | @salesforce/core
    SettingType: {
        members: string[];
        name: "CustomObject" | "RecordType" | "BusinessProcess" | "Settings";
    }

    Type declaration

    • members: string[]
    • name: "CustomObject" | "RecordType" | "BusinessProcess" | "Settings"
    \ No newline at end of file diff --git a/types/org_scratchOrgTypes.ObjectSetting.html b/types/org_scratchOrgTypes.ObjectSetting.html index c6b20bdcf..f971ddef9 100644 --- a/types/org_scratchOrgTypes.ObjectSetting.html +++ b/types/org_scratchOrgTypes.ObjectSetting.html @@ -1 +1 @@ -ObjectSetting | @salesforce/core
    ObjectSetting: {
        defaultRecordType?: string;
        sharingModel?: string;
    } & JsonMap

    Type declaration

    • Optional defaultRecordType?: string
    • Optional sharingModel?: string
    \ No newline at end of file +ObjectSetting | @salesforce/core
    ObjectSetting: {
        defaultRecordType?: string;
        sharingModel?: string;
    } & JsonMap

    Type declaration

    • Optional defaultRecordType?: string
    • Optional sharingModel?: string
    \ No newline at end of file diff --git a/types/org_scratchOrgTypes.ScratchOrgInfo.html b/types/org_scratchOrgTypes.ScratchOrgInfo.html index 83e4f28fd..91531b06f 100644 --- a/types/org_scratchOrgTypes.ScratchOrgInfo.html +++ b/types/org_scratchOrgTypes.ScratchOrgInfo.html @@ -1 +1 @@ -ScratchOrgInfo | @salesforce/core
    ScratchOrgInfo: {
        AdminEmail?: string;
        AuthCode: string;
        ConnectedAppCallbackUrl?: string;
        ConnectedAppConsumerKey?: string;
        Country?: string;
        CreatedDate?: string;
        Description?: string;
        DurationDays?: number;
        Edition?: string;
        ErrorCode?: string;
        ExpirationDate?: string;
        Features?: string;
        HasSampleData?: boolean;
        Id?: string;
        Language?: string;
        LoginUrl: string;
        Name?: string;
        Namespace?: string;
        OrgName?: string;
        Release?: "Current" | "Previous" | "Preview";
        ScratchOrg?: string;
        SignupEmail: string;
        SignupInstance: string;
        SignupUsername: string;
        Snapshot?: string;
        SourceOrg?: string;
        Status: "New" | "Creating" | "Active" | "Error" | "Deleted";
        Username: string;
        objectSettings?: {
            [objectName: string]: ObjectSetting;
        };
        orgPreferences?: {
            disabled: string[];
            enabled: string[];
        };
        settings?: Record<string, unknown>;
    }

    Type declaration

    • Optional AdminEmail?: string
    • Readonly AuthCode: string
    • Optional ConnectedAppCallbackUrl?: string
    • Optional ConnectedAppConsumerKey?: string
    • Optional Country?: string
    • Optional Readonly CreatedDate?: string
    • Optional Description?: string
    • Optional DurationDays?: number
    • Optional Edition?: string
    • Optional Readonly ErrorCode?: string
    • Optional Readonly ExpirationDate?: string
    • Optional Features?: string
    • Optional HasSampleData?: boolean
    • Optional Readonly Id?: string
    • Optional Language?: string
    • LoginUrl: string
    • Optional Readonly Name?: string
    • Optional Namespace?: string
    • Optional OrgName?: string
    • Optional Release?: "Current" | "Previous" | "Preview"
    • Optional Readonly ScratchOrg?: string
    • Readonly SignupEmail: string
    • Readonly SignupInstance: string
    • Readonly SignupUsername: string
    • Optional Snapshot?: string
    • Optional SourceOrg?: string
    • Readonly Status: "New" | "Creating" | "Active" | "Error" | "Deleted"
    • Username: string
    • Optional objectSettings?: {
          [objectName: string]: ObjectSetting;
      }
    • Optional orgPreferences?: {
          disabled: string[];
          enabled: string[];
      }
      • disabled: string[]
      • enabled: string[]
    • Optional settings?: Record<string, unknown>
    \ No newline at end of file +ScratchOrgInfo | @salesforce/core
    ScratchOrgInfo: {
        AdminEmail?: string;
        AuthCode: string;
        ConnectedAppCallbackUrl?: string;
        ConnectedAppConsumerKey?: string;
        Country?: string;
        CreatedDate?: string;
        Description?: string;
        DurationDays?: number;
        Edition?: string;
        ErrorCode?: string;
        ExpirationDate?: string;
        Features?: string;
        HasSampleData?: boolean;
        Id?: string;
        Language?: string;
        LoginUrl: string;
        Name?: string;
        Namespace?: string;
        OrgName?: string;
        Release?: "Current" | "Previous" | "Preview";
        ScratchOrg?: string;
        SignupEmail: string;
        SignupInstance: string;
        SignupUsername: string;
        Snapshot?: string;
        SourceOrg?: string;
        Status: "New" | "Creating" | "Active" | "Error" | "Deleted";
        Username: string;
        objectSettings?: {
            [objectName: string]: ObjectSetting;
        };
        orgPreferences?: {
            disabled: string[];
            enabled: string[];
        };
        settings?: Record<string, unknown>;
    }

    Type declaration

    • Optional AdminEmail?: string
    • Readonly AuthCode: string
    • Optional ConnectedAppCallbackUrl?: string
    • Optional ConnectedAppConsumerKey?: string
    • Optional Country?: string
    • Optional Readonly CreatedDate?: string
    • Optional Description?: string
    • Optional DurationDays?: number
    • Optional Edition?: string
    • Optional Readonly ErrorCode?: string
    • Optional Readonly ExpirationDate?: string
    • Optional Features?: string
    • Optional HasSampleData?: boolean
    • Optional Readonly Id?: string
    • Optional Language?: string
    • LoginUrl: string
    • Optional Readonly Name?: string
    • Optional Namespace?: string
    • Optional OrgName?: string
    • Optional Release?: "Current" | "Previous" | "Preview"
    • Optional Readonly ScratchOrg?: string
    • Readonly SignupEmail: string
    • Readonly SignupInstance: string
    • Readonly SignupUsername: string
    • Optional Snapshot?: string
    • Optional SourceOrg?: string
    • Readonly Status: "New" | "Creating" | "Active" | "Error" | "Deleted"
    • Username: string
    • Optional objectSettings?: {
          [objectName: string]: ObjectSetting;
      }
    • Optional orgPreferences?: {
          disabled: string[];
          enabled: string[];
      }
      • disabled: string[]
      • enabled: string[]
    • Optional settings?: Record<string, unknown>
    \ No newline at end of file diff --git a/types/org_user.DefaultUserFields.Options.html b/types/org_user.DefaultUserFields.Options.html index ecd6918aa..4b12bbe19 100644 --- a/types/org_user.DefaultUserFields.Options.html +++ b/types/org_user.DefaultUserFields.Options.html @@ -1,3 +1,3 @@ Options | @salesforce/core
    Options: {
        newUserName?: string;
        templateUser: string;
    }

    Used to initialize default values for fields based on a templateUser user. This user will be part of the Standard User profile.

    -

    Type declaration

    • Optional newUserName?: string
    • templateUser: string
    \ No newline at end of file +

    Type declaration

    • Optional newUserName?: string
    • templateUser: string
    \ No newline at end of file diff --git a/types/org_user.PasswordConditions.html b/types/org_user.PasswordConditions.html index 6580dc7d9..f524cf797 100644 --- a/types/org_user.PasswordConditions.html +++ b/types/org_user.PasswordConditions.html @@ -1 +1 @@ -PasswordConditions | @salesforce/core

    Type alias PasswordConditions

    PasswordConditions: {
        complexity: number;
        length: number;
    }

    Type declaration

    • complexity: number
    • length: number
    \ No newline at end of file +PasswordConditions | @salesforce/core

    Type alias PasswordConditions

    PasswordConditions: {
        complexity: number;
        length: number;
    }

    Type declaration

    • complexity: number
    • length: number
    \ No newline at end of file diff --git a/types/org_user.User.Options.html b/types/org_user.User.Options.html index e686d1757..0de74256c 100644 --- a/types/org_user.User.Options.html +++ b/types/org_user.User.Options.html @@ -1,3 +1,3 @@ Options | @salesforce/core
    Options: {
        org: Org;
    }

    Used to initialize default values for fields based on a templateUser user. This user will be part of the Standard User profile.

    -

    Type declaration

    \ No newline at end of file +

    Type declaration

    \ No newline at end of file diff --git a/types/org_user.UserFields.html b/types/org_user.UserFields.html index 46d692950..986fc3f75 100644 --- a/types/org_user.UserFields.html +++ b/types/org_user.UserFields.html @@ -1,3 +1,3 @@ UserFields | @salesforce/core
    UserFields: {
        -readonly [K in keyof typeof REQUIRED_FIELDS]: string
    }

    Required fields type needed to represent a Salesforce User object.

    See https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_user.htm

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/sfError.SfErrorOptions.html b/types/sfError.SfErrorOptions.html index 0f5658915..a78bb9a85 100644 --- a/types/sfError.SfErrorOptions.html +++ b/types/sfError.SfErrorOptions.html @@ -1,2 +1,2 @@ SfErrorOptions | @salesforce/core

    Type alias SfErrorOptions<T>

    SfErrorOptions<T>: {
        actions?: string[];
        cause?: unknown;
        context?: string;
        data?: T;
        exitCode?: number;
        message: string;
        name?: string;
    }

    Type Parameters

    • T extends ErrorDataProperties = ErrorDataProperties

    Type declaration

    • Optional actions?: string[]
    • Optional cause?: unknown

      pass an Error. For convenience in catch blocks, code will check that it is, in fact, an Error

      -
    • Optional context?: string
    • Optional data?: T
    • Optional exitCode?: number
    • message: string
    • Optional name?: string
    \ No newline at end of file +
  • Optional context?: string
  • Optional data?: T
  • Optional exitCode?: number
  • message: string
  • Optional name?: string
  • \ No newline at end of file diff --git a/types/sfProject.NamedPackageDir.html b/types/sfProject.NamedPackageDir.html index 46cb94f48..0ae0aea12 100644 --- a/types/sfProject.NamedPackageDir.html +++ b/types/sfProject.NamedPackageDir.html @@ -1 +1 @@ -NamedPackageDir | @salesforce/core
    NamedPackageDir: PackageDir & NameAndFullPath
    \ No newline at end of file +NamedPackageDir | @salesforce/core
    NamedPackageDir: PackageDir & NameAndFullPath
    \ No newline at end of file diff --git a/types/sfProject.NamedPackagingDir.html b/types/sfProject.NamedPackagingDir.html index 4eef494bd..1831336eb 100644 --- a/types/sfProject.NamedPackagingDir.html +++ b/types/sfProject.NamedPackagingDir.html @@ -1 +1 @@ -NamedPackagingDir | @salesforce/core

    Type alias NamedPackagingDir

    NamedPackagingDir: PackagePackageDir & NameAndFullPath
    \ No newline at end of file +NamedPackagingDir | @salesforce/core

    Type alias NamedPackagingDir

    NamedPackagingDir: PackagePackageDir & NameAndFullPath
    \ No newline at end of file diff --git a/types/sfProject.ProjectJson.html b/types/sfProject.ProjectJson.html index b75d3c6c0..c4309cffe 100644 --- a/types/sfProject.ProjectJson.html +++ b/types/sfProject.ProjectJson.html @@ -1 +1 @@ -ProjectJson | @salesforce/core
    ProjectJson: ConfigContents & ProjectJsonSchema
    \ No newline at end of file +ProjectJson | @salesforce/core
    ProjectJson: ConfigContents & ProjectJsonSchema
    \ No newline at end of file diff --git a/types/stateAggregator_accessors_aliasAccessor.Aliasable.html b/types/stateAggregator_accessors_aliasAccessor.Aliasable.html index 4b84293c2..b3bfad6ca 100644 --- a/types/stateAggregator_accessors_aliasAccessor.Aliasable.html +++ b/types/stateAggregator_accessors_aliasAccessor.Aliasable.html @@ -1 +1 @@ -Aliasable | @salesforce/core
    \ No newline at end of file +Aliasable | @salesforce/core
    \ No newline at end of file diff --git a/types/status_myDomainResolver.MyDomainResolver.Options.html b/types/status_myDomainResolver.MyDomainResolver.Options.html index c1f97dfb7..73a152b73 100644 --- a/types/status_myDomainResolver.MyDomainResolver.Options.html +++ b/types/status_myDomainResolver.MyDomainResolver.Options.html @@ -2,4 +2,4 @@

    Type declaration

    • Optional frequency?: Duration

      The retry timeout.

    • Optional timeout?: Duration

      The retry interval.

    • url: URL

      The host to resolve.

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/status_pollingClient.PollingClient.Options.html b/types/status_pollingClient.PollingClient.Options.html index c1ce16b7e..e0862c348 100644 --- a/types/status_pollingClient.PollingClient.Options.html +++ b/types/status_pollingClient.PollingClient.Options.html @@ -5,4 +5,4 @@
  • Optional timeoutErrorName?: string

    Change the name of the timeout error.

    if (err.name === 'MyChangedName) ...
     
    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/status_streamingClient.StreamingClientIfc.html b/types/status_streamingClient.StreamingClientIfc.html index c719dc32a..c6f653dbc 100644 --- a/types/status_streamingClient.StreamingClientIfc.html +++ b/types/status_streamingClient.StreamingClientIfc.html @@ -4,4 +4,4 @@
  • setLogger: ((logLine) => void)

    Sets the logger function for the CometClient.

      • (logLine): void
      • Parameters

        • logLine: ((message) => void)

          A log message passed to the the assigned function.

          -
            • (message): void
            • Parameters

              • message: string

              Returns void

        Returns void

  • \ No newline at end of file +
      • (message): void
      • Parameters

        • message: string

        Returns void

    Returns void

    \ No newline at end of file diff --git a/types/status_types.Callback.html b/types/status_types.Callback.html index eee8b30f0..1a342176b 100644 --- a/types/status_types.Callback.html +++ b/types/status_types.Callback.html @@ -1 +1 @@ -Callback | @salesforce/core
    Callback<T>: ((...args) => T)

    Type Parameters

    • T = unknown

    Type declaration

      • (...args): T
      • Parameters

        • Rest ...args: any[]

        Returns T

    \ No newline at end of file +Callback | @salesforce/core
    Callback<T>: ((...args) => T)

    Type Parameters

    • T = unknown

    Type declaration

      • (...args): T
      • Parameters

        • Rest ...args: any[]

        Returns T

    \ No newline at end of file diff --git a/types/status_types.CometSubscription.html b/types/status_types.CometSubscription.html index 5d75606ed..41c309e7e 100644 --- a/types/status_types.CometSubscription.html +++ b/types/status_types.CometSubscription.html @@ -1,2 +1,2 @@ CometSubscription | @salesforce/core
    CometSubscription: {
        callback(callback): void;
        errback(callback): void;
    }

    The subscription object returned from the cometd subscribe object.

    -

    Type declaration

    • callback:function
      • Parameters

        • callback: (() => void)
            • (): void
            • Returns void

        Returns void

    • errback:function
      • Parameters

        • callback: ((error) => void)
            • (error): void
            • Parameters

              • error: Error

              Returns void

        Returns void

    \ No newline at end of file +

    Type declaration

    • callback:function
      • Parameters

        • callback: (() => void)
            • (): void
            • Returns void

        Returns void

    • errback:function
      • Parameters

        • callback: ((error) => void)
            • (error): void
            • Parameters

              • error: Error

              Returns void

        Returns void

    \ No newline at end of file diff --git a/types/status_types.Message.html b/types/status_types.Message.html index b4dc3cbf0..d3a124980 100644 --- a/types/status_types.Message.html +++ b/types/status_types.Message.html @@ -1 +1 @@ -Message | @salesforce/core
    Message: JsonMap
    \ No newline at end of file +Message | @salesforce/core
    Message: JsonMap
    \ No newline at end of file diff --git a/types/status_types.StatusResult.html b/types/status_types.StatusResult.html index c0eac25fb..0944eeb1c 100644 --- a/types/status_types.StatusResult.html +++ b/types/status_types.StatusResult.html @@ -1,4 +1,4 @@ StatusResult | @salesforce/core
    StatusResult: {
        completed: boolean;
        payload?: AnyJson;
    }

    Type declaration

    • completed: boolean

      Indicates to the streaming or polling client that the subscriber has what its needs. If true the client will end the messaging exchanges with the endpoint.

    • Optional payload?: AnyJson

      If the result of the streaming or polling client is expected to return a result

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/status_types.StreamProcessor.html b/types/status_types.StreamProcessor.html index 9088941a4..1d52dff27 100644 --- a/types/status_types.StreamProcessor.html +++ b/types/status_types.StreamProcessor.html @@ -1,2 +1,2 @@ StreamProcessor | @salesforce/core
    StreamProcessor: ((message) => StatusResult)

    Function type for processing messages

    -

    Type declaration

    \ No newline at end of file +

    Type declaration

    \ No newline at end of file diff --git a/types/status_types.StreamingExtension.html b/types/status_types.StreamingExtension.html index d5db7f2b2..f57b33e6b 100644 --- a/types/status_types.StreamingExtension.html +++ b/types/status_types.StreamingExtension.html @@ -5,4 +5,4 @@

    Returns void

  • Optional outgoing?: ((message, callback) => void)

    Extension for outgoing message.

      • (message, callback): void
      • Parameters

        • message: JsonMap

          The message.

        • callback: AnyFunction

          The callback to invoke after the message is processed.

          -

        Returns void

  • \ No newline at end of file +

    Returns void

    \ No newline at end of file diff --git a/types/testSetup.ConfigStub.html b/types/testSetup.ConfigStub.html index cf0ce5737..ed9fd5c87 100644 --- a/types/testSetup.ConfigStub.html +++ b/types/testSetup.ConfigStub.html @@ -9,4 +9,4 @@
  • Optional retrieveContents?: (() => Promise<JsonMap>)

    A function to conditionally read based on the config instance. The this value will be the config instance.

      • (): Promise<JsonMap>
      • Returns Promise<JsonMap>

  • Optional writeFn?: ((contents?) => Promise<void>)

    A function that controls all aspects of ConfigFile.write. For example, it won't read the contents unless explicitly done. Only use this if you know what you are doing. Use updateContents instead.

    -
      • (contents?): Promise<void>
      • Parameters

        • Optional contents: AnyJson

        Returns Promise<void>

  • \ No newline at end of file +
      • (contents?): Promise<void>
      • Parameters

        • Optional contents: AnyJson

        Returns Promise<void>

    \ No newline at end of file diff --git a/types/testSetup.SandboxTypes.html b/types/testSetup.SandboxTypes.html index 2b071da89..ca9cb85e2 100644 --- a/types/testSetup.SandboxTypes.html +++ b/types/testSetup.SandboxTypes.html @@ -1,4 +1,4 @@ SandboxTypes | @salesforce/core
    SandboxTypes: {
        CONFIG: SinonSandbox;
        CONNECTION: SinonSandbox;
        CRYPTO: SinonSandbox;
        DEFAULT: SinonSandbox;
        FS: SinonSandbox;
        ORGS: SinonSandbox;
        PROJECT: SinonSandbox;
    }

    Different parts of the system that are mocked out. They can be restored for individual tests. Test's stubs should always go on the DEFAULT which is exposed on the TestContext.

    -

    Type declaration

    • CONFIG: SinonSandbox
    • CONNECTION: SinonSandbox
    • CRYPTO: SinonSandbox
    • DEFAULT: SinonSandbox
    • FS: SinonSandbox
    • ORGS: SinonSandbox
    • PROJECT: SinonSandbox
    \ No newline at end of file +

    Type declaration

    • CONFIG: SinonSandbox
    • CONNECTION: SinonSandbox
    • CRYPTO: SinonSandbox
    • DEFAULT: SinonSandbox
    • FS: SinonSandbox
    • ORGS: SinonSandbox
    • PROJECT: SinonSandbox
    \ No newline at end of file diff --git a/types/testSetup.StreamingMockCometSubscriptionOptions.html b/types/testSetup.StreamingMockCometSubscriptionOptions.html index 466707159..885333b2b 100644 --- a/types/testSetup.StreamingMockCometSubscriptionOptions.html +++ b/types/testSetup.StreamingMockCometSubscriptionOptions.html @@ -4,4 +4,4 @@
  • subscriptionCall: StreamingMockSubscriptionCall

    What is the subscription outcome a successful callback or an error?.

  • Optional subscriptionErrbackError?: SfError

    If it's an error that states what that error should be.

  • url: string

    Target URL.

    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/util_structuredWriter.StructuredWriter.html b/types/util_structuredWriter.StructuredWriter.html index 4366302b6..dcc5ee580 100644 --- a/types/util_structuredWriter.StructuredWriter.html +++ b/types/util_structuredWriter.StructuredWriter.html @@ -1 +1 @@ -StructuredWriter | @salesforce/core
    StructuredWriter: {
        get buffer(): Buffer;
        addToStore(contents, path): Promise<void>;
        finalize(): Promise<void>;
        getDestinationPath(): undefined | string;
    }

    Type declaration

    \ No newline at end of file +StructuredWriter | @salesforce/core
    StructuredWriter: {
        get buffer(): Buffer;
        addToStore(contents, path): Promise<void>;
        finalize(): Promise<void>;
        getDestinationPath(): undefined | string;
    }

    Type declaration

    \ No newline at end of file diff --git a/types/webOAuthServer.WebOAuthServer.Options.html b/types/webOAuthServer.WebOAuthServer.Options.html index 4c07614eb..186953905 100644 --- a/types/webOAuthServer.WebOAuthServer.Options.html +++ b/types/webOAuthServer.WebOAuthServer.Options.html @@ -1 +1 @@ -Options | @salesforce/core
    Options: {
        oauthConfig: JwtOAuth2Config;
    }

    Type declaration

    \ No newline at end of file +Options | @salesforce/core
    Options: {
        oauthConfig: JwtOAuth2Config;
    }

    Type declaration

    \ No newline at end of file diff --git a/types/webOAuthServer.WebOAuthServer.Request.html b/types/webOAuthServer.WebOAuthServer.Request.html index dd1f983c4..b367fbb04 100644 --- a/types/webOAuthServer.WebOAuthServer.Request.html +++ b/types/webOAuthServer.WebOAuthServer.Request.html @@ -1 +1 @@ -Request | @salesforce/core
    Request: http.IncomingMessage & {
        query: {
            code: string;
            error?: string;
            error_description?: string;
            state: string;
        };
    }

    Type declaration

    • query: {
          code: string;
          error?: string;
          error_description?: string;
          state: string;
      }
      • code: string
      • Optional error?: string
      • Optional error_description?: string
      • state: string
    \ No newline at end of file +Request | @salesforce/core
    Request: http.IncomingMessage & {
        query: {
            code: string;
            error?: string;
            error_description?: string;
            state: string;
        };
    }

    Type declaration

    • query: {
          code: string;
          error?: string;
          error_description?: string;
          state: string;
      }
      • code: string
      • Optional error?: string
      • Optional error_description?: string
      • state: string
    \ No newline at end of file diff --git a/variables/config_config.SFDX_ALLOWED_PROPERTIES.html b/variables/config_config.SFDX_ALLOWED_PROPERTIES.html index b42283394..3b6e4f251 100644 --- a/variables/config_config.SFDX_ALLOWED_PROPERTIES.html +++ b/variables/config_config.SFDX_ALLOWED_PROPERTIES.html @@ -1 +1 @@ -SFDX_ALLOWED_PROPERTIES | @salesforce/core

    Variable SFDX_ALLOWED_PROPERTIESConst

    SFDX_ALLOWED_PROPERTIES: ({
        deprecated: boolean;
        description: string;
        encrypted?: undefined;
        hidden?: undefined;
        input: {
            failedMessage: string;
            validator: ((value) => boolean);
        };
        key: SfdxPropertyKeys;
        newKey: OrgConfigProperties;
    } | {
        deprecated: boolean;
        description: string;
        encrypted?: undefined;
        hidden?: undefined;
        input?: undefined;
        key: SfdxPropertyKeys;
        newKey: OrgConfigProperties;
    } | {
        deprecated: boolean;
        description: string;
        encrypted: boolean;
        hidden?: undefined;
        input: {
            failedMessage: string;
            validator: ((value) => boolean);
        };
        key: SfdxPropertyKeys;
        newKey: OrgConfigProperties;
    } | {
        deprecated: boolean;
        description: string;
        encrypted?: undefined;
        hidden?: undefined;
        input: {
            failedMessage: string;
            validator: ((value) => boolean);
        };
        key: SfdxPropertyKeys;
        newKey: DISABLE_TELEMETRY;
    } | {
        deprecated: boolean;
        description: string;
        encrypted?: undefined;
        hidden: boolean;
        input: {
            failedMessage: string;
            validator: ((value) => boolean);
        };
        key: SfdxPropertyKeys;
        newKey: string;
    })[] = ...
    \ No newline at end of file +SFDX_ALLOWED_PROPERTIES | @salesforce/core

    Variable SFDX_ALLOWED_PROPERTIESConst

    SFDX_ALLOWED_PROPERTIES: ({
        deprecated: boolean;
        description: string;
        encrypted?: undefined;
        hidden?: undefined;
        input: {
            failedMessage: string;
            validator: ((value) => boolean);
        };
        key: SfdxPropertyKeys;
        newKey: OrgConfigProperties;
    } | {
        deprecated: boolean;
        description: string;
        encrypted?: undefined;
        hidden?: undefined;
        input?: undefined;
        key: SfdxPropertyKeys;
        newKey: OrgConfigProperties;
    } | {
        deprecated: boolean;
        description: string;
        encrypted: boolean;
        hidden?: undefined;
        input: {
            failedMessage: string;
            validator: ((value) => boolean);
        };
        key: SfdxPropertyKeys;
        newKey: OrgConfigProperties;
    } | {
        deprecated: boolean;
        description: string;
        encrypted?: undefined;
        hidden?: undefined;
        input: {
            failedMessage: string;
            validator: ((value) => boolean);
        };
        key: SfdxPropertyKeys;
        newKey: DISABLE_TELEMETRY;
    } | {
        deprecated: boolean;
        description: string;
        encrypted?: undefined;
        hidden: boolean;
        input: {
            failedMessage: string;
            validator: ((value) => boolean);
        };
        key: SfdxPropertyKeys;
        newKey: string;
    })[] = ...
    \ No newline at end of file diff --git a/variables/config_config.SF_ALLOWED_PROPERTIES.html b/variables/config_config.SF_ALLOWED_PROPERTIES.html index 07bc2cb59..c9218b9a9 100644 --- a/variables/config_config.SF_ALLOWED_PROPERTIES.html +++ b/variables/config_config.SF_ALLOWED_PROPERTIES.html @@ -1 +1 @@ -SF_ALLOWED_PROPERTIES | @salesforce/core

    Variable SF_ALLOWED_PROPERTIESConst

    SF_ALLOWED_PROPERTIES: {
        description: string;
        input: {
            failedMessage: string;
            validator: ((value) => boolean);
        };
        key: DISABLE_TELEMETRY;
    }[] = ...

    Type declaration

    • description: string
    • input: {
          failedMessage: string;
          validator: ((value) => boolean);
      }
      • failedMessage: string
      • validator: ((value) => boolean)
          • (value): boolean
          • Parameters

            • value: AnyJson

            Returns boolean

    • key: DISABLE_TELEMETRY
    \ No newline at end of file +SF_ALLOWED_PROPERTIES | @salesforce/core

    Variable SF_ALLOWED_PROPERTIESConst

    SF_ALLOWED_PROPERTIES: {
        description: string;
        input: {
            failedMessage: string;
            validator: ((value) => boolean);
        };
        key: DISABLE_TELEMETRY;
    }[] = ...

    Type declaration

    • description: string
    • input: {
          failedMessage: string;
          validator: ((value) => boolean);
      }
      • failedMessage: string
      • validator: ((value) => boolean)
          • (value): boolean
          • Parameters

            • value: AnyJson

            Returns boolean

    • key: DISABLE_TELEMETRY
    \ No newline at end of file diff --git a/variables/config_config.SfProperty.html b/variables/config_config.SfProperty.html index 3b7a8fb29..2d192fe7a 100644 --- a/variables/config_config.SfProperty.html +++ b/variables/config_config.SfProperty.html @@ -1 +1 @@ -SfProperty | @salesforce/core
    SfProperty: {
        [index: string]: ConfigPropertyMeta;
    } = {}

    Type declaration

    \ No newline at end of file +SfProperty | @salesforce/core
    SfProperty: {
        [index: string]: ConfigPropertyMeta;
    } = {}

    Type declaration

    \ No newline at end of file diff --git a/variables/config_envVars.SUPPORTED_ENV_VARS.html b/variables/config_envVars.SUPPORTED_ENV_VARS.html index 03b0cddcb..d98de5822 100644 --- a/variables/config_envVars.SUPPORTED_ENV_VARS.html +++ b/variables/config_envVars.SUPPORTED_ENV_VARS.html @@ -1 +1 @@ -SUPPORTED_ENV_VARS | @salesforce/core

    Variable SUPPORTED_ENV_VARSConst

    SUPPORTED_ENV_VARS: EnvType = ...
    \ No newline at end of file +SUPPORTED_ENV_VARS | @salesforce/core

    Variable SUPPORTED_ENV_VARSConst

    SUPPORTED_ENV_VARS: EnvType = ...
    \ No newline at end of file diff --git a/variables/config_envVars.envVars-1.html b/variables/config_envVars.envVars-1.html index 579bef8fb..eb5d3cf16 100644 --- a/variables/config_envVars.envVars-1.html +++ b/variables/config_envVars.envVars-1.html @@ -1 +1 @@ -envVars | @salesforce/core
    envVars: EnvVars = ...
    \ No newline at end of file +envVars | @salesforce/core
    envVars: EnvVars = ...
    \ No newline at end of file diff --git a/variables/config_lwwMap.SYMBOL_FOR_DELETED.html b/variables/config_lwwMap.SYMBOL_FOR_DELETED.html index 319158993..f56d51e30 100644 --- a/variables/config_lwwMap.SYMBOL_FOR_DELETED.html +++ b/variables/config_lwwMap.SYMBOL_FOR_DELETED.html @@ -1 +1 @@ -SYMBOL_FOR_DELETED | @salesforce/core

    Variable SYMBOL_FOR_DELETEDConst

    SYMBOL_FOR_DELETED: "UNIQUE_IDENTIFIER_FOR_DELETED" = ...
    \ No newline at end of file +SYMBOL_FOR_DELETED | @salesforce/core

    Variable SYMBOL_FOR_DELETEDConst

    SYMBOL_FOR_DELETED: "UNIQUE_IDENTIFIER_FOR_DELETED" = ...
    \ No newline at end of file diff --git a/variables/logger_filters.HIDDEN.html b/variables/logger_filters.HIDDEN.html index 3ac434731..aa539789a 100644 --- a/variables/logger_filters.HIDDEN.html +++ b/variables/logger_filters.HIDDEN.html @@ -1 +1 @@ -HIDDEN | @salesforce/core
    HIDDEN: "HIDDEN" = 'HIDDEN'
    \ No newline at end of file +HIDDEN | @salesforce/core
    HIDDEN: "HIDDEN" = 'HIDDEN'
    \ No newline at end of file diff --git a/variables/org_authInfo.DEFAULT_CONNECTED_APP_INFO.html b/variables/org_authInfo.DEFAULT_CONNECTED_APP_INFO.html index a77899a99..3a9c55a1e 100644 --- a/variables/org_authInfo.DEFAULT_CONNECTED_APP_INFO.html +++ b/variables/org_authInfo.DEFAULT_CONNECTED_APP_INFO.html @@ -1 +1 @@ -DEFAULT_CONNECTED_APP_INFO | @salesforce/core

    Variable DEFAULT_CONNECTED_APP_INFOConst

    DEFAULT_CONNECTED_APP_INFO: {
        clientId: string;
        clientSecret: string;
    } = ...

    Type declaration

    • clientId: string
    • clientSecret: string
    \ No newline at end of file +DEFAULT_CONNECTED_APP_INFO | @salesforce/core

    Variable DEFAULT_CONNECTED_APP_INFOConst

    DEFAULT_CONNECTED_APP_INFO: {
        clientId: string;
        clientSecret: string;
    } = ...

    Type declaration

    • clientId: string
    • clientSecret: string
    \ No newline at end of file diff --git a/variables/org_connection.DNS_ERROR_NAME.html b/variables/org_connection.DNS_ERROR_NAME.html index 69a6edc6e..c5ba4c8b5 100644 --- a/variables/org_connection.DNS_ERROR_NAME.html +++ b/variables/org_connection.DNS_ERROR_NAME.html @@ -1 +1 @@ -DNS_ERROR_NAME | @salesforce/core
    DNS_ERROR_NAME: "DomainNotFoundError" = 'DomainNotFoundError'
    \ No newline at end of file +DNS_ERROR_NAME | @salesforce/core
    DNS_ERROR_NAME: "DomainNotFoundError" = 'DomainNotFoundError'
    \ No newline at end of file diff --git a/variables/org_connection.SFDX_HTTP_HEADERS.html b/variables/org_connection.SFDX_HTTP_HEADERS.html index 5c7f1727f..d20942cdc 100644 --- a/variables/org_connection.SFDX_HTTP_HEADERS.html +++ b/variables/org_connection.SFDX_HTTP_HEADERS.html @@ -1 +1 @@ -SFDX_HTTP_HEADERS | @salesforce/core

    Variable SFDX_HTTP_HEADERSConst

    SFDX_HTTP_HEADERS: {
        content-type: string;
        user-agent: string;
    } = ...

    Type declaration

    • content-type: string
    • user-agent: string
    \ No newline at end of file +SFDX_HTTP_HEADERS | @salesforce/core

    Variable SFDX_HTTP_HEADERSConst

    SFDX_HTTP_HEADERS: {
        content-type: string;
        user-agent: string;
    } = ...

    Type declaration

    • content-type: string
    • user-agent: string
    \ No newline at end of file diff --git a/variables/org_connection.SingleRecordQueryErrors.html b/variables/org_connection.SingleRecordQueryErrors.html index a4e480e0c..c34d955cb 100644 --- a/variables/org_connection.SingleRecordQueryErrors.html +++ b/variables/org_connection.SingleRecordQueryErrors.html @@ -1 +1 @@ -SingleRecordQueryErrors | @salesforce/core

    Variable SingleRecordQueryErrorsConst

    SingleRecordQueryErrors: {
        MultipleRecords: string;
        NoRecords: string;
    } = ...

    Type declaration

    • MultipleRecords: string
    • NoRecords: string
    \ No newline at end of file +SingleRecordQueryErrors | @salesforce/core

    Variable SingleRecordQueryErrorsConst

    SingleRecordQueryErrors: {
        MultipleRecords: string;
        NoRecords: string;
    } = ...

    Type declaration

    • MultipleRecords: string
    • NoRecords: string
    \ No newline at end of file diff --git a/variables/org_orgConfigProperties.ORG_CONFIG_ALLOWED_PROPERTIES.html b/variables/org_orgConfigProperties.ORG_CONFIG_ALLOWED_PROPERTIES.html index c05e413b3..8a057856a 100644 --- a/variables/org_orgConfigProperties.ORG_CONFIG_ALLOWED_PROPERTIES.html +++ b/variables/org_orgConfigProperties.ORG_CONFIG_ALLOWED_PROPERTIES.html @@ -1 +1 @@ -ORG_CONFIG_ALLOWED_PROPERTIES | @salesforce/core
    ORG_CONFIG_ALLOWED_PROPERTIES: ({
        description: string;
        encrypted?: undefined;
        hidden?: undefined;
        input?: undefined;
        key: OrgConfigProperties;
    } | {
        description: string;
        encrypted?: undefined;
        hidden?: undefined;
        input: {
            failedMessage: string;
            validator: ((value) => boolean);
        };
        key: OrgConfigProperties;
    } | {
        description: string;
        encrypted?: undefined;
        hidden: boolean;
        input: {
            failedMessage: string;
            validator: ((value) => boolean);
        };
        key: OrgConfigProperties;
    } | {
        description: string;
        encrypted: boolean;
        hidden?: undefined;
        input: {
            failedMessage: string;
            validator: ((value) => boolean);
        };
        key: OrgConfigProperties;
    })[] = ...
    \ No newline at end of file +ORG_CONFIG_ALLOWED_PROPERTIES | @salesforce/core
    ORG_CONFIG_ALLOWED_PROPERTIES: ({
        description: string;
        encrypted?: undefined;
        hidden?: undefined;
        input?: undefined;
        key: OrgConfigProperties;
    } | {
        description: string;
        encrypted?: undefined;
        hidden?: undefined;
        input: {
            failedMessage: string;
            validator: ((value) => boolean);
        };
        key: OrgConfigProperties;
    } | {
        description: string;
        encrypted?: undefined;
        hidden: boolean;
        input: {
            failedMessage: string;
            validator: ((value) => boolean);
        };
        key: OrgConfigProperties;
    } | {
        description: string;
        encrypted: boolean;
        hidden?: undefined;
        input: {
            failedMessage: string;
            validator: ((value) => boolean);
        };
        key: OrgConfigProperties;
    })[] = ...
    \ No newline at end of file diff --git a/variables/org_scratchOrgCreate.DEFAULT_STREAM_TIMEOUT_MINUTES.html b/variables/org_scratchOrgCreate.DEFAULT_STREAM_TIMEOUT_MINUTES.html index 4790d1c2c..e20d43112 100644 --- a/variables/org_scratchOrgCreate.DEFAULT_STREAM_TIMEOUT_MINUTES.html +++ b/variables/org_scratchOrgCreate.DEFAULT_STREAM_TIMEOUT_MINUTES.html @@ -1 +1 @@ -DEFAULT_STREAM_TIMEOUT_MINUTES | @salesforce/core

    Variable DEFAULT_STREAM_TIMEOUT_MINUTESConst

    DEFAULT_STREAM_TIMEOUT_MINUTES: 6 = 6
    \ No newline at end of file +DEFAULT_STREAM_TIMEOUT_MINUTES | @salesforce/core

    Variable DEFAULT_STREAM_TIMEOUT_MINUTESConst

    DEFAULT_STREAM_TIMEOUT_MINUTES: 6 = 6
    \ No newline at end of file diff --git a/variables/org_scratchOrgLifecycleEvents.scratchOrgLifecycleEventName.html b/variables/org_scratchOrgLifecycleEvents.scratchOrgLifecycleEventName.html index fe9380136..099ff91f0 100644 --- a/variables/org_scratchOrgLifecycleEvents.scratchOrgLifecycleEventName.html +++ b/variables/org_scratchOrgLifecycleEvents.scratchOrgLifecycleEventName.html @@ -1 +1 @@ -scratchOrgLifecycleEventName | @salesforce/core
    scratchOrgLifecycleEventName: "scratchOrgLifecycleEvent" = 'scratchOrgLifecycleEvent'
    \ No newline at end of file +scratchOrgLifecycleEventName | @salesforce/core
    scratchOrgLifecycleEventName: "scratchOrgLifecycleEvent" = 'scratchOrgLifecycleEvent'
    \ No newline at end of file diff --git a/variables/org_scratchOrgLifecycleEvents.scratchOrgLifecycleStages.html b/variables/org_scratchOrgLifecycleEvents.scratchOrgLifecycleStages.html index 7a20d564c..caa34dc77 100644 --- a/variables/org_scratchOrgLifecycleEvents.scratchOrgLifecycleStages.html +++ b/variables/org_scratchOrgLifecycleEvents.scratchOrgLifecycleStages.html @@ -1 +1 @@ -scratchOrgLifecycleStages | @salesforce/core
    scratchOrgLifecycleStages: readonly ["prepare request", "send request", "wait for org", "available", "authenticate", "deploy settings", "done"] = ...
    \ No newline at end of file +scratchOrgLifecycleStages | @salesforce/core
    scratchOrgLifecycleStages: readonly ["prepare request", "send request", "wait for org", "available", "authenticate", "deploy settings", "done"] = ...
    \ No newline at end of file diff --git a/variables/org_user.REQUIRED_FIELDS.html b/variables/org_user.REQUIRED_FIELDS.html index c013e95f8..50ddb4aab 100644 --- a/variables/org_user.REQUIRED_FIELDS.html +++ b/variables/org_user.REQUIRED_FIELDS.html @@ -1,2 +1,2 @@ REQUIRED_FIELDS | @salesforce/core

    Variable REQUIRED_FIELDSConst

    REQUIRED_FIELDS: {
        alias: string;
        email: string;
        emailEncodingKey: string;
        id: string;
        languageLocaleKey: string;
        lastName: string;
        localeSidKey: string;
        profileId: string;
        timeZoneSidKey: string;
        username: string;
    } = ...

    A Map of Required Salesforce User fields.

    -

    Type declaration

    • alias: string
    • email: string
    • emailEncodingKey: string
    • id: string
    • languageLocaleKey: string
    • lastName: string
    • localeSidKey: string
    • profileId: string
    • timeZoneSidKey: string
    • username: string
    \ No newline at end of file +

    Type declaration

    • alias: string
    • email: string
    • emailEncodingKey: string
    • id: string
    • languageLocaleKey: string
    • lastName: string
    • localeSidKey: string
    • profileId: string
    • timeZoneSidKey: string
    • username: string
    \ No newline at end of file diff --git a/variables/stateAggregator_accessors_aliasAccessor.DEFAULT_GROUP.html b/variables/stateAggregator_accessors_aliasAccessor.DEFAULT_GROUP.html index 00dec59a1..c08b20e73 100644 --- a/variables/stateAggregator_accessors_aliasAccessor.DEFAULT_GROUP.html +++ b/variables/stateAggregator_accessors_aliasAccessor.DEFAULT_GROUP.html @@ -1 +1 @@ -DEFAULT_GROUP | @salesforce/core
    \ No newline at end of file +DEFAULT_GROUP | @salesforce/core
    \ No newline at end of file diff --git a/variables/stateAggregator_accessors_aliasAccessor.FILENAME.html b/variables/stateAggregator_accessors_aliasAccessor.FILENAME.html index 0f19f0dbb..694d7d773 100644 --- a/variables/stateAggregator_accessors_aliasAccessor.FILENAME.html +++ b/variables/stateAggregator_accessors_aliasAccessor.FILENAME.html @@ -1 +1 @@ -FILENAME | @salesforce/core
    \ No newline at end of file +FILENAME | @salesforce/core
    \ No newline at end of file diff --git a/variables/testSetup.unexpectedResult.html b/variables/testSetup.unexpectedResult.html index a2cb25026..2ef4dee38 100644 --- a/variables/testSetup.unexpectedResult.html +++ b/variables/testSetup.unexpectedResult.html @@ -1,3 +1,3 @@ unexpectedResult | @salesforce/core

    Variable unexpectedResultConst

    unexpectedResult: SfError<AnyJson> = ...

    A pre-canned error for try/catch testing.

    See shouldThrow

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/variables/util_internal.traverse.html b/variables/util_internal.traverse.html index 6ae0bf3b0..efd40fa40 100644 --- a/variables/util_internal.traverse.html +++ b/variables/util_internal.traverse.html @@ -10,4 +10,4 @@ not found.

      • (dir, file): Optional<string>
      • Parameters

        • dir: string

          The directory path in which to start the upward search.

        • file: string

          The file name to look for.

          -

        Returns Optional<string>

    \ No newline at end of file +

    Returns Optional<string>

    \ No newline at end of file diff --git a/variables/util_lockRetryOptions.lockOptions.html b/variables/util_lockRetryOptions.lockOptions.html index 840f74efc..9e9e43336 100644 --- a/variables/util_lockRetryOptions.lockOptions.html +++ b/variables/util_lockRetryOptions.lockOptions.html @@ -1 +1 @@ -lockOptions | @salesforce/core
    lockOptions: {
        stale: number;
    } = ...

    Type declaration

    • stale: number
    \ No newline at end of file +lockOptions | @salesforce/core
    lockOptions: {
        stale: number;
    } = ...

    Type declaration

    • stale: number
    \ No newline at end of file diff --git a/variables/util_lockRetryOptions.lockRetryOptions.html b/variables/util_lockRetryOptions.lockRetryOptions.html index 6aa7295c3..ef14ba4ba 100644 --- a/variables/util_lockRetryOptions.lockRetryOptions.html +++ b/variables/util_lockRetryOptions.lockRetryOptions.html @@ -1 +1 @@ -lockRetryOptions | @salesforce/core
    lockRetryOptions: {
        retries: {
            factor: number;
            maxTimeout: number;
            retries: number;
        };
        stale: number;
    } = ...

    Type declaration

    • retries: {
          factor: number;
          maxTimeout: number;
          retries: number;
      }
      • factor: number
      • maxTimeout: number
      • retries: number
    • stale: number
    \ No newline at end of file +lockRetryOptions | @salesforce/core
    lockRetryOptions: {
        retries: {
            factor: number;
            maxTimeout: number;
            retries: number;
        };
        stale: number;
    } = ...

    Type declaration

    • retries: {
          factor: number;
          maxTimeout: number;
          retries: number;
      }
      • factor: number
      • maxTimeout: number
      • retries: number
    • stale: number
    \ No newline at end of file diff --git a/variables/util_sfdc.accessTokenRegex.html b/variables/util_sfdc.accessTokenRegex.html index 1fbdf59ec..7ece4ee39 100644 --- a/variables/util_sfdc.accessTokenRegex.html +++ b/variables/util_sfdc.accessTokenRegex.html @@ -1 +1 @@ -accessTokenRegex | @salesforce/core

    Variable accessTokenRegexConst

    accessTokenRegex: RegExp = ...
    \ No newline at end of file +accessTokenRegex | @salesforce/core

    Variable accessTokenRegexConst

    accessTokenRegex: RegExp = ...
    \ No newline at end of file diff --git a/variables/util_sfdc.sfdxAuthUrlRegex.html b/variables/util_sfdc.sfdxAuthUrlRegex.html index d3989cb0e..a21913052 100644 --- a/variables/util_sfdc.sfdxAuthUrlRegex.html +++ b/variables/util_sfdc.sfdxAuthUrlRegex.html @@ -1 +1 @@ -sfdxAuthUrlRegex | @salesforce/core

    Variable sfdxAuthUrlRegexConst

    sfdxAuthUrlRegex: RegExp = ...
    \ No newline at end of file +sfdxAuthUrlRegex | @salesforce/core

    Variable sfdxAuthUrlRegexConst

    sfdxAuthUrlRegex: RegExp = ...
    \ No newline at end of file