Module index

Index

References

accessTokenRegex AuthFields AuthInfo AuthRemover AuthSideEffects CometClient CometSubscription Config ConfigAggregator ConfigContents ConfigEntry ConfigFile ConfigInfo ConfigPropertyMeta ConfigPropertyMetaInput ConfigStore ConfigValue Connection DefaultUserFields DeviceCodePollingResponse DeviceCodeResponse DeviceOauthService EnvironmentVariable envVars EnvVars Fields FieldValue fs generateApiName getJwtAudienceUrl Global isNamedPackagingDirectory isPackagingDirectory jwtTokenRegex Lifecycle lockInit Logger LoggerLevel LoggerLevelValue LoggerOptions LogLine matchesAccessToken matchesJwtAccessToken matchesOpaqueAccessToken Messages Mode Mutex MyDomainResolver NamedPackageDir Org ORG_CONFIG_ALLOWED_PROPERTIES OrgAuthorization OrgConfigProperties OrgTypes OrgUsersConfig PermissionSetAssignment PermissionSetAssignmentFields PollingClient ProjectJson ProjectJsonSchema REQUIRED_FIELDS ResultEvent ResumeSandboxRequest SandboxEvents SandboxInfo SandboxProcessObject SandboxRequest SandboxRequestCache SandboxRequestCacheEntry SandboxUserAuthRequest SandboxUserAuthResponse SchemaValidator ScratchOrgCache scratchOrgCreate ScratchOrgCreateOptions ScratchOrgCreateResult ScratchOrgDef ScratchOrgDefSchema ScratchOrgInfo ScratchOrgLifecycleEvent scratchOrgLifecycleEventName scratchOrgLifecycleStages ScratchOrgRequest scratchOrgResume ScratchOrgSettingsGenerator SF_ALLOWED_PROPERTIES SfConfigProperties SfdcUrl SFDX_ALLOWED_PROPERTIES SFDX_HTTP_HEADERS sfdxAuthUrlRegex SfdxPropertyKeys SfError SfProject SfProjectJson StateAggregator StatusEvent StatusResult StreamingClient StructuredMessage SUPPORTED_ENV_VARS trimTo15 TTLConfig User UserFields validateApiVersion validateEmail validatePathDoesNotContainInvalidChars validateSalesforceId WebOAuthServer

References

accessTokenRegex

Re-exports accessTokenRegex

AuthFields

Re-exports AuthFields

AuthInfo

Re-exports AuthInfo

AuthRemover

Re-exports AuthRemover

AuthSideEffects

Re-exports AuthSideEffects

CometClient

Re-exports CometClient

CometSubscription

Re-exports CometSubscription

Config

Re-exports Config

ConfigAggregator

Re-exports ConfigAggregator

ConfigContents

Re-exports ConfigContents

ConfigEntry

Re-exports ConfigEntry

ConfigFile

Re-exports ConfigFile

ConfigInfo

Re-exports ConfigInfo

ConfigPropertyMeta

Re-exports ConfigPropertyMeta

ConfigPropertyMetaInput

Re-exports ConfigPropertyMetaInput

ConfigStore

Re-exports ConfigStore

ConfigValue

Re-exports ConfigValue

Connection

Re-exports Connection

DefaultUserFields

Re-exports DefaultUserFields

DeviceCodePollingResponse

Re-exports DeviceCodePollingResponse

DeviceCodeResponse

Re-exports DeviceCodeResponse

DeviceOauthService

Re-exports DeviceOauthService

EnvironmentVariable

Re-exports EnvironmentVariable

envVars

Re-exports envVars

EnvVars

Re-exports EnvVars

Fields

Re-exports Fields

FieldValue

Re-exports FieldValue

fs

Re-exports fs

for use by other libraries that need to support web and node

generateApiName

Re-exports generateApiName

getJwtAudienceUrl

Re-exports getJwtAudienceUrl

Global

Re-exports Global

isNamedPackagingDirectory

Re-exports isNamedPackagingDirectory

isPackagingDirectory

Re-exports isPackagingDirectory

jwtTokenRegex

Re-exports jwtTokenRegex

Lifecycle

Re-exports Lifecycle

lockInit

Re-exports lockInit

Logger

Re-exports Logger

LoggerLevel

Re-exports LoggerLevel

LoggerLevelValue

Re-exports LoggerLevelValue

LoggerOptions

Re-exports LoggerOptions

LogLine

Re-exports LogLine

matchesAccessToken

Re-exports matchesAccessToken

matchesJwtAccessToken

Re-exports matchesJwtAccessToken

matchesOpaqueAccessToken

Re-exports matchesOpaqueAccessToken

Messages

Re-exports Messages

Mode

Re-exports Mode

Mutex

Re-exports Mutex

MyDomainResolver

Re-exports MyDomainResolver

NamedPackageDir

Re-exports NamedPackageDir

Org

Re-exports Org

ORG_CONFIG_ALLOWED_PROPERTIES

Re-exports ORG_CONFIG_ALLOWED_PROPERTIES

OrgAuthorization

Re-exports OrgAuthorization

OrgConfigProperties

Re-exports OrgConfigProperties

OrgTypes

Re-exports OrgTypes

OrgUsersConfig

Re-exports OrgUsersConfig

PermissionSetAssignment

Re-exports PermissionSetAssignment

PermissionSetAssignmentFields

Re-exports PermissionSetAssignmentFields

PollingClient

Re-exports PollingClient

ProjectJson

Re-exports ProjectJson

ProjectJsonSchema

Re-exports ProjectJsonSchema

REQUIRED_FIELDS

Re-exports REQUIRED_FIELDS

ResultEvent

Re-exports ResultEvent

ResumeSandboxRequest

Re-exports ResumeSandboxRequest

SandboxEvents

Re-exports SandboxEvents

SandboxInfo

Re-exports SandboxInfo

SandboxProcessObject

Re-exports SandboxProcessObject

SandboxRequest

Re-exports SandboxRequest

SandboxRequestCache

Re-exports SandboxRequestCache

SandboxRequestCacheEntry

Re-exports SandboxRequestCacheEntry

SandboxUserAuthRequest

Re-exports SandboxUserAuthRequest

SandboxUserAuthResponse

Re-exports SandboxUserAuthResponse

SchemaValidator

Re-exports SchemaValidator

Deprecated

For sfdx-project.json and scratch org definitions, use the exported zod schemas (ProjectJsonSchema, ScratchOrgDefSchema) from '@salesforce/core'. For custom schemas, use a schema validator library like zod directly.

ScratchOrgCache

Re-exports ScratchOrgCache

scratchOrgCreate

Re-exports scratchOrgCreate

ScratchOrgCreateOptions

Re-exports ScratchOrgCreateOptions

ScratchOrgCreateResult

Re-exports ScratchOrgCreateResult

ScratchOrgDef

Re-exports ScratchOrgDef

ScratchOrgDefSchema

Re-exports ScratchOrgDefSchema

ScratchOrgInfo

Re-exports ScratchOrgInfo

ScratchOrgLifecycleEvent

Re-exports ScratchOrgLifecycleEvent

scratchOrgLifecycleEventName

Re-exports scratchOrgLifecycleEventName

scratchOrgLifecycleStages

Re-exports scratchOrgLifecycleStages

ScratchOrgRequest

Re-exports ScratchOrgRequest

scratchOrgResume

Re-exports scratchOrgResume

ScratchOrgSettingsGenerator

Renames and re-exports default

SF_ALLOWED_PROPERTIES

Re-exports SF_ALLOWED_PROPERTIES

SfConfigProperties

Re-exports SfConfigProperties

SfdcUrl

Re-exports SfdcUrl

SFDX_ALLOWED_PROPERTIES

Re-exports SFDX_ALLOWED_PROPERTIES

SFDX_HTTP_HEADERS

Re-exports SFDX_HTTP_HEADERS

sfdxAuthUrlRegex

Re-exports sfdxAuthUrlRegex

SfdxPropertyKeys

Re-exports SfdxPropertyKeys

SfError

Re-exports SfError

SfProject

Re-exports SfProject

SfProjectJson

Re-exports SfProjectJson

StateAggregator

Re-exports StateAggregator

StatusEvent

Re-exports StatusEvent

StatusResult

Re-exports StatusResult

StreamingClient

Re-exports StreamingClient

StructuredMessage

Re-exports StructuredMessage

SUPPORTED_ENV_VARS

Re-exports SUPPORTED_ENV_VARS

trimTo15

Re-exports trimTo15

TTLConfig

Re-exports TTLConfig

User

Re-exports User

UserFields

Re-exports UserFields

validateApiVersion

Re-exports validateApiVersion

validateEmail

Re-exports validateEmail

validatePathDoesNotContainInvalidChars

Re-exports validatePathDoesNotContainInvalidChars

validateSalesforceId

Re-exports validateSalesforceId

WebOAuthServer

Re-exports WebOAuthServer