arbiter
DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/arbiter package

2.0.2 • Public • Published

Arbiter

npmCoverage StatusBuild

Arbiter is a Salesforce ORM for Nodejs with the goal of making modeling and querying Salesforce as painless as possible. With powerful schemas for validation and field remappings, Arbiter is the perfect layer to have between you and Salesforce.

Arbiter is built on top of the popular JSforce query library. People familiar with its api will feel right at home in Arbiter since most of the api is mirrored. Also, JSForce connection objects are exposed providing escape hatches when needed, or an eased migration to Arbiter.

What you get with Arbiter:

  • A Declarative way of defining models and associations between them
  • Extended query building API. JSForce with more helpers
  • Field remappings. No longer are you tied to your Salesforce field names. Create your own that are easier to reason about or matches your problem domain. Or just to strip out those darn underscores...
  • Smart query results. Makes updating and creating new objects quick and easy
  • Optional field validation and defaults

What Arbiter doesn't give you:

  • A way to modify Salesforce objects and schemas. You will still need Salesforce devs to do that. The objects and relations have to be in place in order for Arbiter to query them.
  • Automatic loading of Salesforce schemas. Arbiter schemas must be writen by hand. This means that you don't have to follow your Salesforce setup exactly and allows you to map fields to completely different names to align with your problem domain. This could be seen as a downside but hopefully after trying the library you will appreciate the flexibility.

Arbiter does everything it can to get you down the happy path of making queries and getting access to your Salesforce data. Many of the helpers and additions are to help handle edge that arise when querying nested relations from Salesforce.

Checkout the documentation

Package Sidebar

Install

npm i arbiter

Weekly Downloads

7

Version

2.0.2

License

ISC

Unpacked Size

598 kB

Total Files

95

Last publish

Collaborators

  • skbolton