@creatio-tech/core
v3.0.0
Published
Creatio Core Package
Downloads
29
Readme
Creatio.Core
Creatio.Code it is a Node JS package that contains good practices and reusable base common components. This package can be applied to any web component such as:
- NodeJS Envs
- Cloud Function
- Google App Engine
- Google Cloud Run
- Google Kubernate Engine
- Node Express Server
Getting Started
- Install enviroment (NodeJS)
- Install dependencies: npm install
- Build: npm run build
- Publish: npm publish
Build and Test
- Build: npm run build
- Test: npm run test
- TDD: npm run tdd
Documentation
Creatio Packages Dependencies
TypeDocs
Table of Contents
Entity
Class set to manage entities
IClassTransformation
Interfaz to manage class transformation
IClassValidation
Interfaz to manage class validation
BaseEntity
Base Class for Entities
BaseDto
Base Class for Dto
BaseList
Base List Class for Entities
SearchOptions
Search Class for Entities
BaseError
Base Error class to represent errors
Enum
Enums set to manage types
FilterType
Filter Type for Entity Results [Datastore, Firestore]
OrderType
Order Type for Entity Results [Datastore, Firestore]
SortType
Sort Type for Entity Results [ascending, descending]
EnvironmentType
Application Environment Type [local, test, prod]
ErrorStatus
Error Status enum to represent Hypertext Transfer Protocol (HTTP) response status codes.
Filter
Class to handle multiple filters in the databases
Order
Class to handle order in the database
Helper
Utility package set for NodeJS components
ContainerHelper
Class to handle containers in the apps
ErrorHelper
Class to handle erros
QueryRequestHelper
Class to handle queries to the database
ValidatorHelper
Class to validate entities
MemoryHelper
Class to handle memory
EncodeHelper
Class to generate code from source
StringHelper
Class to handle strings
TraceHelper
Class to handle traces
Contribute
If you are interested in fixing issues and contributing directly to the code, please contact to the project manager. Here is how you can contribute to Creatio.Core:
- Submit bugs and help us verify fixes
- Submit pull requests for bug fixes and features and discuss existing proposals