@dailyom-suite/models

This library is intended to be used as a shared resource for types, models, and interfaces across the DailyOM Suite applications. It helps maintain consistency and reusability of types throughout the codebase. Make sure to keep the types well-documented and organized for easy reference by other developers.

This library was generated with Nx

Command used to generate it:

nx generate @nx/js:lib libs/models

Add new type / model / interface

To add a new type, model, or interface to this library, follow these steps:

1. Create a new file or folder of types under the src/lib directory.
2. Define your type, model, or interface in that file.
3. Export the type, model, or interface from the root index.ts file of the library. If a folder of types is created, ensure to export all types from that folder in the index.ts file.
4. Run the following command to ensure the library is built and ready for use:

nx build models

Usage

To use the types, models, or interfaces defined in this library, import them in your application or other libraries as follows:

import { MyType } from '@evdy-consumer/dailyom-suite-models';

CI

PRs that contain changes to models will run tests and builds to ensure project structure is adhered to.