npm.io
2.42.1 • Published 5 years ago

@turnkeyvr/common-types

Licence
UNLICENSED
Version
2.42.1
Deps
1
Size
88 kB
Vulns
0
Weekly
0

common-types

An npm package that contains common types and interfaces to be used throughout TurnKey applications.

Structure

This library is structured using 2 major assumptions:

  • Objects that are never meant to be instantiated will be declared as Types
  • Objects that are meant to be implemented (such as by a class) will be declared as Interfaces

Types that represent Salesforce objects are represented by appending SF to the object type (ie, the RentalSF type represents the Opportunity__c object as it exists in Salesforce).

Classes that are built from these Salesforce types have more UI-friendly field names and, in some cases, manipulate the data from Salesforce when an object is created. These should be represented by an Interface in this library and implemented in the consuming application.