Class SfdcUrl

constructor

• new SfdcUrl(input, base?): SfdcUrl

• Parameters

  • input: string | URL
  • Optionalbase: string | URL

  Returns SfdcUrl

Static ReadonlyPRODUCTION

Static ReadonlySANDBOX

checkLightningDomain

• checkLightningDomain(): Promise<true>

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

getJwtAudienceUrl

• getJwtAudienceUrl(createdOrgInstance?): Promise<string>

• Returns the appropriate jwt audience url for this url Use SF_AUDIENCE_URL env var to override the audience url

  Parameters

  • OptionalcreatedOrgInstance: string

    The Salesforce instance the org was created on. e.g. cs42

  Returns Promise<string>

  The audience url

isInternalUrl

• isInternalUrl(): boolean

• Tests whether this url is an internal Salesforce domain

  Returns boolean

  true if this is an internal domain

isLightningDomain

• isLightningDomain(): boolean

• Test whether this url represents a lightning domain

  Returns boolean

  true if this domain is a lightning domain

isLocalUrl

• isLocalUrl(): boolean

• Tests whether this url runs on a local machine

  Returns boolean

  true if this is a local machine

isSalesforceDomain

• isSalesforceDomain(): boolean

• Tests whether this url contains a Salesforce owned domain

  Returns boolean

  true if this is a salesforce domain

lookup

• lookup(): Promise<string>

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

toLightningDomain

• toLightningDomain(): string

• Returns string

StaticisValidUrl

• isValidUrl(input): boolean

• Parameters

  • input: string | URL

  Returns boolean