@types/jsforce

What is @types/jsforce?

@types/jsforce provides TypeScript definitions for the jsforce library, which is a powerful Salesforce API library for Node.js. It allows developers to interact with Salesforce services, including data manipulation, metadata management, and more, using TypeScript.

What are @types/jsforce's main functionalities?

Authentication

This feature allows you to authenticate with Salesforce using a username and password. The code sample demonstrates how to establish a connection and log in to Salesforce.

const jsforce = require('jsforce');
const conn = new jsforce.Connection();
conn.login('username', 'password', 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 data from Salesforce using SOQL (Salesforce Object Query Language). The code sample demonstrates how to query Account records and log the results.

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 code sample demonstrates how to create a new Account record.

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);
});

Metadata Management

This feature allows you to manage Salesforce metadata, such as custom objects and fields. The code sample demonstrates how to read metadata for a custom object.

conn.metadata.read('CustomObject', 'MyCustomObject__c', function(err, metadata) {
  if (err) { return console.error(err); }
  console.log('Metadata: ' + JSON.stringify(metadata));
});

Other packages similar to @types/jsforce

node-salesforce

node-salesforce is another Node.js module for interfacing with Salesforce. 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

nforce is a Node.js client for Salesforce REST API. It offers functionalities like authentication, querying, and CRUD operations. Compared to jsforce, nforce is simpler and more lightweight but may lack some advanced features available in jsforce.

salesforce-connection

salesforce-connection is a lightweight library for connecting to Salesforce and performing basic operations. It is less comprehensive than jsforce but can be a good choice for simpler use cases.

README

Installation

npm install --save @types/jsforce

Summary

This package contains type definitions for jsforce (https://github.com/jsforce/jsforce).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/jsforce

Additional Details

• Last updated: Sun, 27 May 2018 14:13:13 GMT
• Dependencies: stream, events
• Global values: none

Credits

These definitions were written by Dolan Miu https://github.com/dolanmiu, Kamil Ejsymont https://github.com/netes, Thomas Dvornik https://github.com/amphro, Tim Noonan https://github.com/tnoonan-salesforce.