jsforce

What is jsforce?

The jsforce npm package is a powerful library for interacting with Salesforce from Node.js. It provides a comprehensive set of tools for working with Salesforce's REST API, SOAP API, Bulk API, and more. This makes it an excellent choice for developers looking to integrate Salesforce with their Node.js applications.

What are jsforce's main functionalities?

Authentication

This feature allows you to authenticate with Salesforce using a username, password, and security token. Once authenticated, you can perform various operations on Salesforce data.

const jsforce = require('jsforce');
const conn = new jsforce.Connection();
conn.login('[e-mail]', 'password+securityToken', function(err, userInfo) {
  if (err) { return console.error(err); }
  console.log('User ID: ' + userInfo.id);
  console.log('Org ID: ' + userInfo.organizationId);
});

Querying Data

This feature allows you to query Salesforce data using SOQL (Salesforce Object Query Language). The example demonstrates how to fetch Account records.

const jsforce = require('jsforce');
const conn = new jsforce.Connection();
conn.login('[e-mail]', 'password+securityToken', function(err, userInfo) {
  if (err) { return console.error(err); }
  conn.query('SELECT Id, Name FROM Account', function(err, result) {
    if (err) { return console.error(err); }
    console.log('Total records: ' + result.totalSize);
    console.log('Fetched records: ' + result.records.length);
  });
});

CRUD Operations

This feature allows you to perform CRUD (Create, Read, Update, Delete) operations on Salesforce objects. The example shows how to create a new Account record.

const jsforce = require('jsforce');
const conn = new jsforce.Connection();
conn.login('[e-mail]', 'password+securityToken', function(err, userInfo) {
  if (err) { return console.error(err); }
  conn.sobject('Account').create({ Name: 'New Account' }, function(err, ret) {
    if (err || !ret.success) { return console.error(err, ret); }
    console.log('Created record id: ' + ret.id);
  });
});

Bulk API

This feature allows you to perform bulk operations on Salesforce data, which is useful for handling large volumes of records efficiently. The example demonstrates how to insert multiple Account records using the Bulk API.

const jsforce = require('jsforce');
const conn = new jsforce.Connection();
conn.login('[e-mail]', 'password+securityToken', function(err, userInfo) {
  if (err) { return console.error(err); }
  const records = [{ Name: 'Account 1' }, { Name: 'Account 2' }];
  conn.bulk.load('Account', 'insert', records, function(err, rets) {
    if (err) { return console.error(err); }
    for (let i = 0; i < rets.length; i++) {
      if (rets[i].success) {
        console.log('Created record id: ' + rets[i].id);
      } else {
        console.log('Error: ' + rets[i].errors.join(', '));
      }
    }
  });
});

Other packages similar to jsforce

node-salesforce

The node-salesforce package is another library for interacting with Salesforce from Node.js. It provides similar functionalities to jsforce, such as authentication, querying, and CRUD operations. However, jsforce is generally considered more feature-rich and better maintained.

nforce

The nforce package is a lightweight Node.js wrapper for the Salesforce REST API. It offers basic functionalities like authentication, querying, and CRUD operations. While it is simpler and easier to use, it lacks some of the advanced features provided by jsforce, such as support for the Bulk API and SOAP API.

README

jsforce

Salesforce API Library for JavaScript applications (both on web browser and Node.js)

Overview

JSforce (f.k.a. Node-Salesforce) is an isomorphic JavaScript Library utilizing Salesforce's API: It works both in the browser and with Node.js.

It capsulates the access to various APIs provided by Salesforce in asynchronous JavaScript function calls.

It also has command line interface (CLI) which gives interactive console (REPL), so you can learn the usage without hassle.

Supported Salesforce APIs are the following:

• REST API (SOQL, SOSL, describe, etc.)
• Apex REST
• Analytics API
• Bulk API
• Chatter API
• Metadata API
• SOAP API
• Streaming API
• Tooling API

Documentation

See documentation in http://jsforce.github.io/ .

Releases

See Releases.

License

See license (MIT License).

Authors

• Shinichi Tomita [e-mail]

Notes

If you have any questions first file it on issues before contacting authors via e-mail.

Tests

In order to run tests you will need a Salesforce Developer Org

You will also need to install the JsforceTestSuite package, which can be done by running:

SF_USERNAME=myusername SF_PASSWORD=password+securityToken ./test/bin/org-setup

You may need to run this more then once if you encounter timeouts or dropped connections/

Finally, to run the tests simply do:

SF_USERNAME=myusername SF_PASSWORD=password+securityToken npm run test:node

SF_USERNAME=myusername SF_PASSWORD=password+securityToken npm run test:browser

Alternatively, if you are using sfdx and have a default DevHub set up, you can create a scratch org with all the test setup ready by running ./test/bin/org-setup-sfdx.sh (it's a bash script and probably won't help most windows users)

Contributions

Your contributions are welcome: both by reporting issues on GitHub issues or pull-requesting patches.

If you want to implement any additional features, to be added to JSforce to our master branch, which may or may not be merged please first check current opening issues with milestones and confirm whether the feature is on road map or not.

If your feature implementation is brand-new or fixing unsupposed bugs in the library's test cases, please include additional test codes in the test/ directory.