Skip to content

Quick Start Guide

Get started with Salesforce ORM in 5 minutes!

Step 1: Install

npm install javascript-salesforce-connector

Step 2: Configure

import { SalesforceConfig } from 'javascript-salesforce-connector';

SalesforceConfig.initialize({
  instanceUrl: 'https://your-instance.salesforce.com',
  apiVersion: 'v59.0'
});

SalesforceConfig.setAccessToken('your-access-token');

Use the CLI to auto-generate models from Salesforce metadata:

# Initialize config
npx sfc init

# Generate models
npx sfc scaffold Account Contact Opportunity

Step 4: Query with Type Safety

import { Account } from './models/Account';

// Query with lambda syntax
const industry = 'Technology';
const accounts = await Account
  .select(x => ({
    Id: x.Id,
    Name: x.Name,
    Industry: x.Industry
  }))
  .where(x => x.Industry === industry)
  .limit(10)
  .get();

// Use the results
for (const account of accounts) {
  console.log(account.Name, account.Industry);
}

Step 5: Create, Update, Delete

// Create
const account = await Account.create({
  Name: 'Acme Corporation',
  Industry: 'Technology'
});

// Update
account.Industry = 'Finance';
await account.save();

// Delete
await account.delete();

What's Next?