Class SfdxConnectionProvider

This interface describes objects that can provide JSForce connections, it provides some abstraction from whom the class that providing the connection which is usefull

Hierarchy (View Summary)

SalesforceConnectionProvider
- SfdxConnectionProvider

Index

Constructors

Properties

jsforceProvider logger options? usernameOrAlias version?

Methods

getApiVersion getJsForceConnection initConnectionProvider isProductionOrg normalizeVersion setApiVersion

Constructors

constructor

new SfdxConnectionProvider(
usernameOrAlias: string,
options?: SalesforceConnectionOptions,
): SfdxConnectionProvider
Parameters
- usernameOrAlias: string
- Optionaloptions: SalesforceConnectionOptions
Returns SfdxConnectionProvider
Overrides SalesforceConnectionProvider.constructor
- Defined in packages/salesforce/src/connection/providers/sfdxConnectionProvider.ts:14

Properties

`Private`jsforceProvider

jsforceProvider: JsForceConnectionProvider

`Private`logger

logger: Logger = ...

`Private` `Optional` `Readonly`options

options?: SalesforceConnectionOptions

`Private` `Readonly`usernameOrAlias

usernameOrAlias: string

`Private` `Optional`version

version?: string

Methods

getApiVersion

getApiVersion(): string
Returns string
Overrides SalesforceConnectionProvider.getApiVersion
- Defined in packages/salesforce/src/connection/providers/sfdxConnectionProvider.ts:56

getJsForceConnection

getJsForceConnection(): Promise<SalesforceConnection>
Returns Promise<SalesforceConnection>
Overrides SalesforceConnectionProvider.getJsForceConnection
- Defined in packages/salesforce/src/connection/providers/sfdxConnectionProvider.ts:19

`Private`initConnectionProvider

initConnectionProvider(): Promise<void>
Returns Promise<void>
- Defined in packages/salesforce/src/connection/providers/sfdxConnectionProvider.ts:36

isProductionOrg

isProductionOrg(): Promise<boolean>
Returns Promise<boolean>
Overrides SalesforceConnectionProvider.isProductionOrg
- Defined in packages/salesforce/src/connection/providers/sfdxConnectionProvider.ts:49

`Private`normalizeVersion

normalizeVersion(version: string | number): string
Parameters
- version: string | number
Returns string
- Defined in packages/salesforce/src/connection/providers/sfdxConnectionProvider.ts:67

setApiVersion

setApiVersion(version: string): void
Parameters
- version: string
Returns void
- Defined in packages/salesforce/src/connection/providers/sfdxConnectionProvider.ts:60