Class Connection<S>

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

tooling

get tooling(): Tooling<S>
Tooling api reference.

Returns Tooling<S>
Overrides JSForceConnection.tooling
- Defined in src/org/connection.ts:102

Methods

autoFetchQuery

autoFetchQuery<T>(soql: string, queryOptions?: Partial<QueryOptions & {
tooling: boolean;
}>): Promise<QueryResult<T>>
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>>
- Defined in src/org/connection.ts:378

baseUrl

baseUrl(): string
The Force API base url for the instance.

Returns string
- Defined in src/org/connection.ts:213

deploy

deploy(zipInput: Buffer, options: DeployOptionsWithRest): Promise<DeployResultLocator<AsyncResult & Schema>>
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>>
- Defined in src/org/connection.ts:172

deployRecentValidation

deployRecentValidation(options: recentValidationOptions): Promise<JsonCollection>
Will deploy a recently validated deploy request - directly calling jsforce now that this is supported. WARNING: will always return a string from jsforce, the type is JsonCollection to support backwards compatibility

Deprecated
use Connection.metadata#deployRecentValidation instead - the jsforce implementation, instead of this wrapper
Parameters
- options: recentValidationOptions
Returns Promise<JsonCollection>
- Defined in src/org/connection.ts:227

getApiVersion

getApiVersion(): string
Get the API version used for all connection requests.

Returns string
- Defined in src/org/connection.ts:306

getAuthInfo

getAuthInfo(): AuthInfo
Getter for AuthInfo.

Returns AuthInfo
- Defined in src/org/connection.ts:327

getAuthInfoFields

getAuthInfoFields(): AuthFields
Getter for the AuthInfo fields.

Returns AuthFields
- Defined in src/org/connection.ts:334

getConnectionOptions

getConnectionOptions(): AuthFields
Getter for the auth fields.

Returns AuthFields
- Defined in src/org/connection.ts:342

getUsername

getUsername(): Optional<string>
Getter for the username of the Salesforce Org.

Returns Optional<string>
- Defined in src/org/connection.ts:349

init

init(): Promise<void>
Async initializer.

Returns Promise<void>
- Defined in src/org/connection.ts:161

isResolvable

isResolvable(): Promise<boolean>
Verify that instance has a reachable DNS entry, otherwise will throw error

Returns Promise<boolean>
- Defined in src/org/connection.ts:283

isUsingAccessToken

isUsingAccessToken(): boolean
Returns true if this connection is using access token auth.

Returns boolean
- Defined in src/org/connection.ts:356

normalizeUrl

normalizeUrl(url: string): string
Normalize a Salesforce url to include a instance information.
Parameters
- url: string
  
  Partial url.
Returns string
- Defined in src/org/connection.ts:365

refreshAuth

refreshAuth(): Promise<void>
Executes a get request on the baseUrl to force an auth refresh Useful for the raw methods (request, requestRaw) that use the accessToken directly and don't handle refreshes

Returns Promise<void>
- Defined in src/org/connection.ts:441

request

request<R>(request: string | HttpRequest, options?: JsonMap): StreamPromise<R>
Send REST API request with given HTTP request info, with connected session information and SFDX headers.
Type Parameters
- R = unknown
Parameters
- request: string | HttpRequest
  
  HTTP request object or URL to GET request.
- Optional options: JsonMap
  
  HTTP API request options.
Returns StreamPromise<R>
Overrides JSForceConnection.request
- Defined in src/org/connection.ts:196

retrieveMaxApiVersion

retrieveMaxApiVersion(): Promise<string>
Retrieves the highest api version that is supported by the target server instance.

Returns Promise<string>
- Defined in src/org/connection.ts:235

setApiVersion

setApiVersion(version: string): void
Set the API version for all connection requests.

Throws SfError{ name: 'IncorrectAPIVersionError' } Incorrect API version.
Parameters
- version: string
  
  The API version.
Returns void
- Defined in src/org/connection.ts:317

singleRecordQuery

singleRecordQuery<T>(soql: string, options?: SingleRecordQueryOptions): Promise<T>
Executes a query using either standard REST or Tooling API, returning a single record. Will throw if either zero records are found OR multiple records are found.
Type Parameters
- T extends Record
Parameters
- soql: string
  
  The SOQL string.
- options: SingleRecordQueryOptions = ...
  
  The query options.
Returns Promise<T>
- Defined in src/org/connection.ts:415

useLatestApiVersion

useLatestApiVersion(): Promise<void>
Use the latest API version available on this.instanceUrl.

Returns Promise<void>
- Defined in src/org/connection.ts:267

`Static` create

create<S>(this: (new (options: Connection.Options<S>) => Connection<S>), options: Connection.Options<S>): Promise<Connection<S>>
Creates an instance of a Connection. Performs additional async initializations.
Type Parameters
- S extends Schema
Parameters
- this: (new (options: Connection.Options<S>) => Connection<S>)
  - - new (options: Connection.Options<S>): Connection<S>
    - Parameters
      
      options: Connection.Options<S>
      
      Returns Connection<S>
- options: Connection.Options<S>
  
  Constructor options.
Returns Promise<Connection<S>>
- Defined in src/org/connection.ts:111

Class Connection<S>

Type Parameters

S extends Schema = Schema

Hierarchy

Index

Accessors

Methods

Accessors

tooling

Returns Tooling<S>

Methods

autoFetchQuery

Type Parameters

T extends Schema = S

Parameters

soql: string

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

Returns Promise<QueryResult<T>>

baseUrl

Returns string

deploy

Parameters

zipInput: Buffer

options: DeployOptionsWithRest

Returns Promise<DeployResultLocator<AsyncResult & Schema>>

deployRecentValidation

Deprecated

Parameters

options: recentValidationOptions

Returns Promise<JsonCollection>

getApiVersion

Returns string

getAuthInfo

Returns AuthInfo

getAuthInfoFields

Returns AuthFields

getConnectionOptions

Returns AuthFields

getUsername

Returns Optional<string>

init

Returns Promise<void>

isResolvable

Returns Promise<boolean>

isUsingAccessToken

Returns boolean

normalizeUrl

Parameters

url: string

Returns string

refreshAuth

Returns Promise<void>

request

Type Parameters

R = unknown

Parameters

request: string | HttpRequest

Optional options: JsonMap

Returns StreamPromise<R>

retrieveMaxApiVersion

Returns Promise<string>

setApiVersion

Parameters

version: string

Returns void

singleRecordQuery

Type Parameters

T extends Record

Parameters

soql: string

options: SingleRecordQueryOptions = ...

Returns Promise<T>

useLatestApiVersion

Returns Promise<void>

Static create

Type Parameters

S extends Schema

Parameters

this: (new (options: Connection.Options<S>) => Connection<S>)

Parameters

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

`Optional` options: JsonMap

`Static` create