Tooling | @salesforce/core

Hierarchy

Tooling
- Tooling

Index

Properties

_logger

_logger: any

Static defaultMaxListeners

defaultMaxListeners: number

Methods

_baseUrl

_baseUrl(): string

Inherited from BaseConnection._baseUrl
- Defined in @types/jsforce/connection.d.ts:94
Returns string

addListener

addListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.addListener

Overrides EventEmitter.addListener
- Defined in @types/node/index.d.ts:1082
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

autoFetchQuery

autoFetchQuery<T>(soql: string, options?: ExecuteOptions): Promise<QueryResult<T>>

- Defined in connection.ts:55
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
Parameters
- soql: string
  
  The SOQL string.
- Optional options: ExecuteOptions
  
  The query options. NOTE: the autoFetch option will always be true.
Returns Promise<QueryResult<T>>

create

create<T>(type: string, records: Record<T> | Array<Record<T>>, options?: Object, callback?: undefined | function): Promise<SuccessResult | ErrorResult | (SuccessResult | ErrorResult)[]>

Inherited from BaseConnection.create
- Defined in @types/jsforce/connection.d.ts:98
Type parameters
- T
Parameters
- type: string
- records: Record<T> | Array<Record<T>>
- Optional options: Object
- Optional callback: undefined | function
Returns Promise<SuccessResult | ErrorResult | (SuccessResult | ErrorResult)[]>

del

del<T>(type: string, ids: string | string[], options?: Object, callback?: undefined | function): Promise<SuccessResult | ErrorResult | (SuccessResult | ErrorResult)[]>

Inherited from BaseConnection.del
- Defined in @types/jsforce/connection.d.ts:108
Type parameters
- T
Parameters
- type: string
- ids: string | string[]
- Optional options: Object
- Optional callback: undefined | function
Returns Promise<SuccessResult | ErrorResult | (SuccessResult | ErrorResult)[]>

delete

delete<T>(type: string, ids: string | string[], options?: Object, callback?: undefined | function): Promise<SuccessResult | ErrorResult | (SuccessResult | ErrorResult)[]>

Inherited from BaseConnection.delete
- Defined in @types/jsforce/connection.d.ts:110
Type parameters
- T
Parameters
- type: string
- ids: string | string[]
- Optional options: Object
- Optional callback: undefined | function
Returns Promise<SuccessResult | ErrorResult | (SuccessResult | ErrorResult)[]>

describe

describe<T>(type: string, callback?: undefined | function): Promise<DescribeSObjectResult>

Inherited from BaseConnection.describe
- Defined in @types/jsforce/connection.d.ts:114
Type parameters
- T
Parameters
- type: string
- Optional callback: undefined | function
Returns Promise<DescribeSObjectResult>

describeGlobal

describeGlobal<T>(callback?: undefined | function): Promise<DescribeGlobalResult>

Inherited from BaseConnection.describeGlobal
- Defined in @types/jsforce/connection.d.ts:115
Type parameters
- T
Parameters
- Optional callback: undefined | function
Returns Promise<DescribeGlobalResult>

destroy

destroy<T>(type: string, ids: string | string[], options?: Object, callback?: undefined | function): Promise<SuccessResult | ErrorResult | (SuccessResult | ErrorResult)[]>

Inherited from BaseConnection.destroy
- Defined in @types/jsforce/connection.d.ts:112
Type parameters
- T
Parameters
- type: string
- ids: string | string[]
- Optional options: Object
- Optional callback: undefined | function
Returns Promise<SuccessResult | ErrorResult | (SuccessResult | ErrorResult)[]>

emit

emit(event: string | symbol, ...args: any[]): boolean

Inherited from EventEmitter.emit

Overrides EventEmitter.emit
- Defined in @types/node/index.d.ts:1094
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames

Overrides EventEmitter.eventNames
- Defined in @types/node/index.d.ts:1095
Returns Array<string | symbol>

executeAnonymous

executeAnonymous(body: string, callback?: undefined | function): Promise<ExecuteAnonymousResult>

Inherited from Tooling.executeAnonymous
- Defined in @types/jsforce/connection.d.ts:149
Parameters
- body: string
- Optional callback: undefined | function
Returns Promise<ExecuteAnonymousResult>

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in @types/node/index.d.ts:1091
Returns number

insert

insert<T>(type: string, records: Record<T> | Array<Record<T>>, options?: Object, callback?: undefined | function): Promise<SuccessResult | ErrorResult | (SuccessResult | ErrorResult)[]>

Inherited from BaseConnection.insert
- Defined in @types/jsforce/connection.d.ts:100
Type parameters
- T
Parameters
- type: string
- records: Record<T> | Array<Record<T>>
- Optional options: Object
- Optional callback: undefined | function
Returns Promise<SuccessResult | ErrorResult | (SuccessResult | ErrorResult)[]>

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in @types/node/index.d.ts:1096
Parameters
- type: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
- Defined in @types/node/index.d.ts:1092
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: function): this

Inherited from EventEmitter.off

Overrides EventEmitter.off
- Defined in @types/node/index.d.ts:1088
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

on

on(event: string | symbol, listener: function): this

Inherited from EventEmitter.on

Overrides EventEmitter.on
- Defined in @types/node/index.d.ts:1083
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

once

once(event: string | symbol, listener: function): this

Inherited from EventEmitter.once

Overrides EventEmitter.once
- Defined in @types/node/index.d.ts:1084
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependListener

prependListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependListener

Overrides EventEmitter.prependListener
- Defined in @types/node/index.d.ts:1085
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in @types/node/index.d.ts:1086
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

query

query<T>(soql: string, options?: ExecuteOptions, callback?: undefined | function): Query<QueryResult<T>>

Inherited from BaseConnection.query
- Defined in @types/jsforce/connection.d.ts:96
Type parameters
- T
Parameters
- soql: string
- Optional options: ExecuteOptions
- Optional callback: undefined | function
Returns Query<QueryResult<T>>

queryMore

queryMore<T>(locator: string, options?: ExecuteOptions, callback?: undefined | function): Promise<QueryResult<T>>

Inherited from BaseConnection.queryMore
- Defined in @types/jsforce/connection.d.ts:97
Type parameters
- T
Parameters
- locator: string
- Optional options: ExecuteOptions
- Optional callback: undefined | function
Returns Promise<QueryResult<T>>

rawListeners

rawListeners(event: string | symbol): Function[]

Inherited from EventEmitter.rawListeners

Overrides EventEmitter.rawListeners
- Defined in @types/node/index.d.ts:1093
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in @types/node/index.d.ts:1089
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.removeListener

Overrides EventEmitter.removeListener
- Defined in @types/node/index.d.ts:1087
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

request

request(info: RequestInfo | string, options?: Object, callback?: undefined | function): Promise<Object>

Inherited from BaseConnection.request
- Defined in @types/jsforce/connection.d.ts:95
Parameters
- info: RequestInfo | string
- Optional options: Object
- Optional callback: undefined | function
Returns Promise<Object>

retrieve

retrieve<T>(type: string, ids: string | string[], options?: Object, callback?: undefined | function): Promise<object & T | (object & T)[]>

Inherited from BaseConnection.retrieve
- Defined in @types/jsforce/connection.d.ts:102
Type parameters
- T
Parameters
- type: string
- ids: string | string[]
- Optional options: Object
- Optional callback: undefined | function
Returns Promise<object & T | (object & T)[]>

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in @types/node/index.d.ts:1090
Parameters
- n: number
Returns this

sobject

sobject<T>(resource: string): SObject<T>

Inherited from BaseConnection.sobject
- Defined in @types/jsforce/connection.d.ts:116
Type parameters
- T
Parameters
- resource: string
Returns SObject<T>

update

update<T>(type: string, records: Record<T> | Array<Record<T>>, options?: Object, callback?: undefined | function): Promise<SuccessResult | ErrorResult | (SuccessResult | ErrorResult)[]>

Inherited from BaseConnection.update
- Defined in @types/jsforce/connection.d.ts:104
Type parameters
- T
Parameters
- type: string
- records: Record<T> | Array<Record<T>>
- Optional options: Object
- Optional callback: undefined | function
Returns Promise<SuccessResult | ErrorResult | (SuccessResult | ErrorResult)[]>

upsert

upsert<T>(type: string, records: Record<T> | Array<Record<T>>, extIdField: string, options?: Object, callback?: undefined | function): Promise<SuccessResult | ErrorResult | (SuccessResult | ErrorResult)[]>

Inherited from BaseConnection.upsert
- Defined in @types/jsforce/connection.d.ts:106
Type parameters
- T
Parameters
- type: string
- records: Record<T> | Array<Record<T>>
- extIdField: string
- Optional options: Object
- Optional callback: undefined | function
Returns Promise<SuccessResult | ErrorResult | (SuccessResult | ErrorResult)[]>

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in @types/node/index.d.ts:1079
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Hierarchy

Index

Properties

Methods

Properties

_logger

Static defaultMaxListeners

Methods

_baseUrl

Returns string

addListener

Parameters

event: string | symbol

listener: function

Parameters

Rest ...args: any[]

Returns void

Returns this

autoFetchQuery

Type parameters

T

Parameters

soql: string

Optional options: ExecuteOptions

Returns Promise<QueryResult<T>>

create

Type parameters

T

Parameters

type: string

records: Record<T> | Array<Record<T>>

Optional options: Object

Optional callback: undefined | function

Returns Promise<SuccessResult | ErrorResult | (SuccessResult | ErrorResult)[]>

del

Type parameters

T

Parameters

type: string

ids: string | string[]

Optional options: Object

Optional callback: undefined | function

Returns Promise<SuccessResult | ErrorResult | (SuccessResult | ErrorResult)[]>

delete

Type parameters

T

Parameters

type: string

ids: string | string[]

Optional options: Object

Optional callback: undefined | function

Returns Promise<SuccessResult | ErrorResult | (SuccessResult | ErrorResult)[]>

describe

Type parameters

T

Parameters

type: string

Optional callback: undefined | function

Returns Promise<DescribeSObjectResult>

describeGlobal

Type parameters

T

Parameters

Optional callback: undefined | function

Returns Promise<DescribeGlobalResult>

destroy

Type parameters

T

Parameters

type: string

ids: string | string[]

Optional options: Object

Optional callback: undefined | function

Returns Promise<SuccessResult | ErrorResult | (SuccessResult | ErrorResult)[]>

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

eventNames