Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Tooling

Hierarchy

  • Tooling
    • Tooling

Index

Properties

_logger

_logger: any

describe$

describe$: function

Type declaration

    • (type: string, callback?: undefined | function): DescribeSObjectResult
    • Returns a value from the cache if it exists, otherwise calls Connection.describe

      Parameters

      • type: string
      • Optional callback: undefined | function

      Returns DescribeSObjectResult

describeGlobal$

describeGlobal$: function

Type declaration

    • (callback?: undefined | function): DescribeGlobalResult
    • Returns a value from the cache if it exists, otherwise calls Connection.describeGlobal

      Parameters

      • Optional callback: undefined | function

      Returns DescribeGlobalResult

Static defaultMaxListeners

defaultMaxListeners: number

Methods

_baseUrl

  • _baseUrl(): string
  • Returns string

addListener

  • addListener(event: string | symbol, listener: function): this
  • 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>>
  • 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?: RestApiOptions, callback?: undefined | function): Promise<SuccessResult | ErrorResult | (SuccessResult | ErrorResult)[]>
  • Type parameters

    • T

    Parameters

    • type: string
    • records: Record<T> | Array<Record<T>>
    • Optional options: RestApiOptions
    • Optional callback: undefined | function

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

del

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

    • T

    Parameters

    • type: string
    • ids: string | string[]
    • Optional options: RestApiOptions
    • Optional callback: undefined | function

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

delete

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

    • T

    Parameters

    • type: string
    • ids: string | string[]
    • Optional options: RestApiOptions
    • Optional callback: undefined | function

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

describe

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

    • type: string
    • Optional callback: undefined | function

    Returns Promise<DescribeSObjectResult>

describeGlobal

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

    • T

    Parameters

    • Optional callback: undefined | function

    Returns Promise<DescribeGlobalResult>

destroy

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

    • T

    Parameters

    • type: string
    • ids: string | string[]
    • Optional options: RestApiOptions
    • Optional callback: undefined | function

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

emit

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

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): Array<string | symbol>
  • Returns Array<string | symbol>

executeAnonymous

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

    • body: string
    • Optional callback: undefined | function

    Returns Promise<ExecuteAnonymousResult>

getMaxListeners

  • getMaxListeners(): number
  • Returns number

insert

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

    • T

    Parameters

    • type: string
    • records: Record<T> | Array<Record<T>>
    • Optional options: RestApiOptions
    • Optional callback: undefined | function

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

listenerCount

  • listenerCount(type: string | symbol): number
  • Parameters

    • type: string | symbol

    Returns number

listeners

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

    • event: string | symbol

    Returns Function[]

off

  • off(event: string | symbol, listener: function): this
  • 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
  • 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
  • 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
  • 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
  • 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>>
  • 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>>
  • Type parameters

    • T

    Parameters

    • locator: string
    • Optional options: ExecuteOptions
    • Optional callback: undefined | function

    Returns Promise<QueryResult<T>>

rawListeners

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

    • event: string | symbol

    Returns Function[]

removeAllListeners

  • removeAllListeners(event?: string | symbol): this
  • Parameters

    • Optional event: string | symbol

    Returns this

removeListener

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

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

request

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

    • info: RequestInfo | string
    • Optional options: HttpApiOptions
    • Optional callback: undefined | function

    Returns Promise<Object>

retrieve

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

    • T

    Parameters

    • type: string
    • ids: string | string[]
    • Optional options: RestApiOptions
    • Optional callback: undefined | function

    Returns Promise<object & T | (object & T)[]>

setMaxListeners

  • setMaxListeners(n: number): this
  • Parameters

    • n: number

    Returns this

sobject

  • sobject<T>(resource: string): SObject<T>
  • Type parameters

    • T

    Parameters

    • resource: string

    Returns SObject<T>

update

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

    • T

    Parameters

    • type: string
    • records: Record<T> | Array<Record<T>>
    • Optional options: RestApiOptions
    • Optional callback: undefined | function

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

upsert

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

    • T

    Parameters

    • type: string
    • records: Record<T> | Array<Record<T>>
    • extIdField: string
    • Optional options: RestApiOptions
    • Optional callback: undefined | function

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

Static listenerCount

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

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number