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.
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('username@example.com', '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('username@example.com', '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('username@example.com', '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('username@example.com', '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(', '));
}
}
});
});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.
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.
Salesforce API Library for JavaScript applications (both on web browser and Node.js)
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:
See documentation in https://jsforce.github.io/
v3 API reference: https://jsforce.github.io/jsforce/
v1 API reference: https://jsforce.github.io/jsforce/doc/
Migrating from v1 → v3? Find the migration guide here
Migrating from v2 → v3? Find the migration guide here
See Releases.
See jsforce-node.
See license (MIT License).
If you have any questions first file it on issues before contacting authors via e-mail.
See DEVELOPING.md
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 main 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.
FAQs
Salesforce API Library for JavaScript
The npm package jsforce receives a total of 469,358 weekly downloads. As such, jsforce popularity was classified as popular.
We found that jsforce demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.