Class SalesforceDeployment

An event emitter that has better support async methods giving the emitter the option to execute event handlers async in sequence instead of in parallel.

All handlers can be removed using

If async event handlers throw an error when hideExceptions is set to false the emitter will receive the error.

Example

// Prints "Hello world" after 1 second
// before "End!"
const emitter = new AsyncEventEmitter();
emitter.on('hello', async (params) => {
  await new Promise(resolve => setTimeout(resolve, 1000));
  console.log('Hello', params); 
});
// pass `{async: true}` to not await the handler completion
// which will print "End!" before "Hello world"
await emitter.emit('hello', 'world'); 
console.log('End!');

Hierarchy

Constructors

constructor

Properties

cancelled checkInterval compressionLevel connection deployOptions deploymentId lastPrintedLogStamp lastStatus logInterval logger nextProgressTimeoutId pollCount salesforce sfPackage

Accessors

deploymentPackage hasErrors id isCancelled isCompleted isPartialSuccess isServerSideCancelled result setupUrl status

Methods

cancel checkDeployment checkDeploymentSafe dispose emit getResult isDependentClassError on onCallbackEmitError once processDeployResult processDetailedResult removeAllListeners removeListener start

Constructors

constructor

Properties

Private cancelled

cancelled: undefined | true

Private checkInterval

checkInterval: number = 1000

compressionLevel

compressionLevel: number = 7

Deflate compression level of the Salesforce deployment package (zip file)

Private connection

connection: SalesforceConnection

Private deployOptions

deployOptions: DeployOptions

Private deploymentId

deploymentId: string

Private lastPrintedLogStamp

lastPrintedLogStamp: number = 0

Private lastStatus

lastStatus: DeployResult

logInterval

logInterval: number = 5000

Interval in milliseconds in which data is reported back on the progress event

Private Readonly logger

logger: Logger = ...

Private nextProgressTimeoutId

nextProgressTimeoutId: Timeout

Private pollCount

pollCount: number = 0

Private Readonly salesforce

salesforce: SalesforceConnectionProvider = ...

Private Readonly sfPackage

sfPackage: SalesforcePackage

Accessors

deploymentPackage

hasErrors

id

isCancelled

isCompleted

  • get isCompleted(): boolean

  • Determine if the deployment has completed, either successfully or with errors or warnings. Returns false if the deployment has not yet started. Returns true if the deployment is completed.

    Returns boolean

isPartialSuccess

isServerSideCancelled

result

setupUrl

status

Methods

cancel

Private checkDeployment

Private checkDeploymentSafe

dispose

emit

getResult

Private isDependentClassError

on

Protected onCallbackEmitError

  • Handles the error that occurs when emitting a callback event.

    Parameters

    • err: unknown

      The error that occurred.

    • event: string

      The name of the event.

    • failedCallback: EventReceiver<any>

      The failed callback event receiver.

    Returns void

once

Private processDeployResult

Private processDetailedResult

removeAllListeners

  • Removes all listeners, or those of the specified event.

    It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

    Returns a reference to the EventEmitter, so that calls can be chained.

    Type Parameters

    Parameters

    • Optional event: K

      event type to remove listeners for if not specified all listeners are removed

    Returns void

removeListener

start

Settings

Member Visibility

Theme

On This Page