# @turnkeyvr/common-types

> Typings and interfaces for common TurnKey domain objects.

Latest version **2.42.1** (published 2021-07-29) · UNLICENSED license · 0 weekly downloads

## Install

```sh
npm install @turnkeyvr/common-types
pnpm add @turnkeyvr/common-types
yarn add @turnkeyvr/common-types
bun add @turnkeyvr/common-types
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.42.1 |
| Published | 2021-07-29 |
| First published | 2019-12-03 |
| Weekly downloads | 0 |
| License | UNLICENSED |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 88.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | TurnKey Dev |
| Maintainers | nate.exe, jsatterfield, akemi_tk, eric.carr, dsquires, arc6789, rhoyer, bretwarren, aidanp, c27cochran, beardles, hnbowen, tkvr-integration, ajewe, cchapman89, isaacjensen |

## Links

- npm: https://www.npmjs.com/package/@turnkeyvr/common-types
- Repository: https://github.com/TurnKeyVR/common-types
- Homepage: https://github.com/TurnKeyVR/common-types#readme
- Issues: https://github.com/TurnKeyVR/common-types/issues
- npm.io page: https://npm.io/package/@turnkeyvr/common-types

## Dependencies (1)

- [@turnkeyvr/common-utils](https://npm.io/package/@turnkeyvr/common-utils.md) ^1.3.13

## Recent versions

- 2.42.1 (latest) — 2021-07-29
- 2.9.0-canary.a9e4c25.0 (canary) — 2020-02-12
- 2.42.0 — 2021-07-28
- 2.41.0 — 2021-07-07
- 2.40.0 — 2021-07-07
- 2.39.0 — 2021-06-23
- 2.38.0 — 2021-05-07
- 2.37.1 — 2021-03-16
- 2.37.0 — 2021-03-12
- 2.36.1 — 2021-03-05
- 2.36.0 — 2021-03-05
- 2.35.0 — 2021-02-02
- 2.34.3 — 2020-12-11
- 2.34.2 — 2020-12-11
- 2.34.1 — 2020-12-11
- … 104 more at https://npm.io/package/@turnkeyvr/common-types/versions

## README

# 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.

---
_Source: https://npm.io/package/@turnkeyvr/common-types · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._