Skip to main content

Create Entity Service


Creates the service of an entity

Event Name:


Event Params

export interface CreateEntityServiceParams extends EventParams {
entityName: string;
templateMapping: { [key: string]: any };
passwordFields: EntityField[];
serviceId: namedTypes.Identifier;
serviceBaseId: namedTypes.Identifier;
template: namedTypes.File;


The name of the entity for which we are generating the service


A template file that is used to generate the service This is the default template that is used for this event.

You can manipulate the template or replace it completely with a new template in your plugin.


An object with values that are available in the interpolation process of the template.
This default object with the available parameters can be found here

You can manipulate the object by adding new values, or replacing existing values that will be used in the template when creating the service file.


List of fields of type Password that are used in this entity


The Identifier of the service that is used as the class name. e.g. CustomerService


The Identifier of the base service that is used as the class name. e.g. CustomerServiceBase