ts-force-config.json

Generated Typescript classes for Salesforce

Type object
File match ts-force-config.json
Schema URL https://catalog.lintel.tools/schemas/schemastore/ts-force-config-json/latest.json
Source https://www.schemastore.org/ts-force-config.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

auth object
8 nested properties
accessToken string
clientId string
clientSecret string
instanceUrl string
oAuthHost string
password string
username string

If using sfdx-cli auth, this is the only property needed to authenticate. Otherwise, supply additional oAuth parameters

version number
enforcePicklistValues enum

Make picklist fields strongly typed to generated enums. generatePicklists must also be true ALL: for all picklist fields, regardless of salesforce enforcement RESTRICTED: only on fields where the values are restricted on Salesforce

Values: "ALL" "RESTRICTED" false
generatePicklists boolean

Flag to generate enums for picklist fields. Defaulted to false

outPath string

The path to generate files to. If the destination is a folder, it will generate one file per object. If the destination is a .ts file, a single file will be generated. If not set, class output will be logged to stdout

sObjects SObjectConfig | string[]

The SObjects to generate classes for. Can either be a string or an SObjectConfig object

Definitions

AuthConfig object
accessToken string
clientId string
clientSecret string
instanceUrl string
oAuthHost string
password string
username string

If using sfdx-cli auth, this is the only property needed to authenticate. Otherwise, supply additional oAuth parameters

version number
FieldMapping object
apiName string required

The Target SObject API name

propName string required

The generated class property name

SObjectConfig object

Object used to configure advanced settings on SObject generation

apiName string required

The Target SObject API name

autoConvertNames boolean

Defaulted to true. If set to false, names will NOT be auto-converted to standard javascript conventions

className string

The generated class name. If not set, it will be automatically converted to standard javascript Class convention

enforcePicklistValues enum

Overrides Global Setting The path to generate files to. If the destination is a folder, it will generate one file per object. If the destination is a .ts file, a single file will be generated. If not set, class output will be logged to stdout

Values: "ALL" "RESTRICTED" false
fieldMappings FieldMapping[]

List of field mappings to override the auto-conversion

generatePicklists boolean

Overrides Global Setting Make picklist fields strongly typed to generated enums. generatePicklists must also be true ALL: for all picklist fields, regardless of salesforce enforcement RESTRICTED: only on fields where the values are restricted on Salesforce