Skip to content

Latest commit

 

History

History
30 lines (19 loc) · 1.76 KB

README.md

File metadata and controls

30 lines (19 loc) · 1.76 KB
Raw

ts-force

alt text alt text

ts-force is a light-weight Salesforce ORM (more like an "opinionated" REST API client), which uses code generation to bring type safety to SObjects. It can be run both in browser or in node.js.

The MISSION of this project is to:

  1. Create the BEST possible developer experience for working with the salesforce REST API by:
  • Providing types for SObjects that are resilient to schema changes
  • Mapping SF API names to js friendly syntax
  • Make constructing SOQL queries as easy and fool-proof as possible. See Demo
  • Provide "Quality of Life" features by abstracting away some of the more tedious parts of working with the REST API (EG: queryMore, translating multi-select picklist to arrays, standardize error handling, etc)
  1. Maintain acceptable performance & reliability

This repository contains two packages:

  • alt text: The runtime library for working with the REST API
  • alt text: A development CLI tool for generating SObject classes

Getting Started

The fastest way to get up and going with this library is to follow the "Getting Started" tutorial.

For additional information, see the individual packages readme: