@jsforce/jsforce-node

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 https://jsforce.github.io/

v3 API reference: https://jsforce.github.io/jsforce/

v1 API reference: https://jsforce.github.io/jsforce/doc/

Migration

Migrating from v1 → v3? Find the migration guide here

Migrating from v2 → v3? Find the migration guide here

Releases

See Releases.

Node-specific release

See jsforce-node.

License

See license (MIT License).

Authors

• Shinichi Tomita [e-mail]

Notes

SOAP Login API Deprecation Notice

The SOAP login() API will be retired in Summer '27 (API version 65.0). If you are using the loginBySoap method, please migrate to OAuth 2.0 Username-Password Flow instead. For more information, see Salesforce Release Notes.

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

How to build/run tests:

See DEVELOPING.md

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 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.

Similar packages

Other packages similar to @jsforce/jsforce-node

node-salesforce

node-salesforce is another popular library for interacting with Salesforce from Node.js. It offers similar functionalities such as authentication, CRUD operations, and SOQL queries. However, @jsforce/jsforce-node is generally considered more feature-rich and better maintained.

nforce

nforce is a lightweight Node.js library for interacting with Salesforce. It provides basic functionalities like authentication and CRUD operations but lacks some of the advanced features available in @jsforce/jsforce-node, such as bulk operations and streaming API support.

salesforce-connection

salesforce-connection is a simple library for connecting to Salesforce and performing basic operations. It is less comprehensive compared to @jsforce/jsforce-node and is suitable for simpler use cases where advanced features are not required.