@salesforce/apex-node

What is @salesforce/apex-node?

@salesforce/apex-node is an npm package that allows developers to interact with Salesforce Apex classes and methods from Node.js applications. It provides functionalities to execute Apex code, run tests, and retrieve test results programmatically.

What are @salesforce/apex-node's main functionalities?

Execute Anonymous Apex

This feature allows you to execute anonymous Apex code on a Salesforce instance. The code sample demonstrates how to log in to Salesforce and execute a simple Apex code snippet.

const { Connection, ExecuteAnonymousResponse } = require('@salesforce/apex-node');

async function executeAnonymousApex() {
  const conn = new Connection({ loginUrl: 'https://login.salesforce.com' });
  await conn.login('username', 'password');
  const apexCode = 'System.debug(\'Hello, World!\');';
  const result = await conn.tooling.executeAnonymous(apexCode);
  console.log(result);
}

executeAnonymousApex();

Run Apex Tests

This feature allows you to run Apex tests asynchronously. The code sample demonstrates how to log in to Salesforce and run tests for a specified list of test classes.

const { Connection, RunTestsAsynchronousResponse } = require('@salesforce/apex-node');

async function runApexTests() {
  const conn = new Connection({ loginUrl: 'https://login.salesforce.com' });
  await conn.login('username', 'password');
  const testClasses = ['MyTestClass'];
  const result = await conn.tooling.runTestsAsynchronous(testClasses);
  console.log(result);
}

runApexTests();

Retrieve Test Results

This feature allows you to retrieve the results of previously run Apex tests. The code sample demonstrates how to log in to Salesforce and query the ApexTestResult object to get test results.

const { Connection, QueryResult } = require('@salesforce/apex-node');

async function getTestResults() {
  const conn = new Connection({ loginUrl: 'https://login.salesforce.com' });
  await conn.login('username', 'password');
  const query = 'SELECT Id, Status, ApexClassId FROM ApexTestResult';
  const result = await conn.tooling.query(query);
  console.log(result.records);
}

getTestResults();

Other packages similar to @salesforce/apex-node

jsforce

Jsforce is a powerful library for Salesforce API integration in JavaScript. It provides a wide range of functionalities including data manipulation, metadata API access, and Apex execution. Compared to @salesforce/apex-node, Jsforce offers a broader set of features for interacting with Salesforce, but may require more configuration for specific Apex-related tasks.

README

Salesforce Apex Library

Introduction

Typescript library to support the Apex plugin and Salesforce Extensions for VS Code.

Note: Please report any issues via the Issues tab.

Getting Started

If you're interested in contributing, take a look at the CONTRIBUTING guide.

If you're interested in building the plugin and library locally, take a look at the Developing doc.