https://github.com/chuckjonas/ts-force

A Salesforce REST Client written in Typescript for Typescript
https://github.com/chuckjonas/ts-force

api-client browser nodejs orm salesforce typescript

Last synced: 8 months ago
JSON representation

A Salesforce REST Client written in Typescript for Typescript

• Host: GitHub
• URL: https://github.com/chuckjonas/ts-force
• Owner: ChuckJonas
• Created: 2017-09-09T15:12:46.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2025-01-28T23:37:37.000Z (over 1 year ago)
• Last Synced: 2025-10-06T03:40:36.117Z (9 months ago)
• Topics: api-client, browser, nodejs, orm, salesforce, typescript
• Language: TypeScript
• Homepage:
• Size: 1000 KB
• Stars: 92
• Watchers: 5
• Forks: 23
• Open Issues: 20
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          


[![build status](https://img.shields.io/github/actions/workflow/status/ChuckJonas/ts-force/ci.yaml?label=CI&logo=github)](https://github.com/ChuckJonas/ts-force/actions/workflows/ci.yaml)

[![npm version](https://img.shields.io/npm/v/ts-force.svg)](https://www.npmjs.org/package/ts-force)

[![license](https://img.shields.io/badge/license-BSD--3--CLAUSE-blue.svg)](https://github.com/ChuckJonas/ts-force/blob/master/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](https://stackblitz.com/edit/ts-force-query-playground)

  * 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)

2. Maintain acceptable performance & reliability

## Usage

[See Documentation](https://ts-force.gitbook.io/ts-force/)