bf-types
v5.52.46
Published
common type definitions and constants for block-5
Downloads
239
Readme
Doc Links
How to add a new Module
Referenced Variables | Variable | Description | | Domain | Domain that the module is grouped under | | Module | Name of the new Module | | ModuleFolder | Folder in which the module is defined |
- Add a the ModuleFolder to src/core/domains/{domain}/{module}
- If domain is core just use src/core/{module}
- UpperCamel cased
- Add
export * from './{ModuleFolder}';
to the parent index for the domain - in src/core/DomainInfo.ts
- Add your module name to {Domain}_MODULES in UPPER_SNAKE
ModuleFolder structure
- {Module}.ts
- UpperCamel Cased
- export const {Module}Properties of type
ModuleProperty[]
- export interface I{Module} with all module property docs
- index.ts
- Exports * from './{Module}.ts'
How to Add a New Module Property
Note When you see ${ModuleProperty} ${MODULE_PROPERTY} ${module_property} or ${moduleProperty} replace with the module property name in the same case(Upper/Lower Camel/Snake)
add a ModuleProperty Folder src/core/ModuleProperties/${ModuleProperty} add files in that folder ${ModulePropeerty}.ts and index.ts
In ${ModulePropeerty}.ts Define your Types and commands Your commands should extend IModulePropertyCommandDTO your type your events should extend IModulePropertyEventDTO
also add a type of ${ModuleProperty}Doc which is the type that the field will be in the documents
in index.ts
export * from './${ModuleProperty}';
in 'src/core/ModuleProperties/ModuleProperties.ts'
// Add to top section
export * from './${ModuleProperty}';
// Add to this
export const ModuleProperty = Object.freeze({
${MODULE_PROPERTY} : '${module_property}'
}
Then add it to any modules that should have it