@earnup/ts-types NPM

ts-types

The ts-types package provides common TypeScript & Javascript type definitions for use in TS & JS applications @ EarnUp. The following are good candidates for this repo:

Enums
Constant definitions
Custom TS Types
TS Interfaces
TS Classes that are re-usable across repos
The following are not good candidates for this repo:
TS Classes that have methods specific to an API/DAO or are otherwise limited to a single app
Implementation specific type definitions (ex: GetLoanCallbackResponse)
Environment variables
Utility functions
Third Party types or reflective imports from other libraries
Getting Started
There is no "app" to run in this repository. To run tests run
```
npm i
npm test
```
To manually build, run npm run build. Manual publishing is disallowed for this repository.
Contributing
To add a type, choose a sensible location or add a semantically named file to the src directory. Create your variable, constant, type, enum, etc definition and make sure it is properly exported. If you are not adding onto an existing export, add your export to index.ts like:
```
export * as MyModuleName from './MyModule';
```
Releasing
To cut a release, use the "Releases" feature of GitHub. Tag your release using semantic versioning like 1.2.3. Do not prefix your version with a "v" like v1.2.3, as it will not publish properly.
You can either write your own release notes or allow release notes to be generated for you. The release will be managed by GitHub actions and the workflow can be found in the "Actions" tab for monitoring purposes.