Skip to content

A Salesforce REST Client written in Typescript for Typescript

Notifications You must be signed in to change notification settings

ChuckJonas/ts-force

Repository files navigation

ts-force

build status npm version license

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

Usage

See Documentation