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:113

Methods

autoFetchQuery

autoFetchQuery<T extends Schema = S>(
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:368

baseUrl

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

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

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:175

getApiVersion

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

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

getAuthInfo

getAuthInfo(): AuthInfo
Getter for AuthInfo.

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

getAuthInfoFields

getAuthInfoFields(): AuthFields
Getter for the AuthInfo fields.

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

getConnectionOptions

getConnectionOptions(): AuthFields
Getter for the auth fields.

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

getUsername

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

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

init

init(): Promise<void>
Async initializer.

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

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:273

isUsingAccessToken

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

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

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:355

refreshAuth

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

This method issues a request using the current access token to check if it is still valid. If the request returns 200, no refresh happens, and we keep the token. If it returns 401, jsforce will request a new token and set it in the connection instance.

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

request

request<R = unknown>(
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.
- Optionaloptions: JsonMap
  HTTP API request options.
Returns StreamPromise<R>
Overrides JSForceConnection.request
- Defined in src/org/connection.ts:198

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:224

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:307

singleRecordQuery

singleRecordQuery<T extends Record>(
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:405

useLatestApiVersion

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

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

`Static`create

create<S extends Schema>(
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>
- options: Connection.Options<S>
  Constructor options.
Returns Promise<Connection<S>>
- Defined in src/org/connection.ts:122

Class Connection<S>

Type Parameters

Hierarchy

Index

Accessors

Methods

Accessors

tooling

Returns Tooling<S>

Methods

autoFetchQuery

Type Parameters

Parameters

Returns Promise<QueryResult<T>>

baseUrl

Returns string

deploy

Parameters

Returns Promise<DeployResultLocator<AsyncResult & Schema>>

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

Returns string

refreshAuth

Returns Promise<void>

request

Type Parameters

Parameters

Returns StreamPromise<R>

retrieveMaxApiVersion

Returns Promise<string>

setApiVersion

Parameters

Returns void

singleRecordQuery

Type Parameters

Parameters

Returns Promise<T>

useLatestApiVersion

Returns Promise<void>

Staticcreate

Type Parameters

Parameters

Returns Promise<Connection<S>>

Settings

On This Page

`Static`create