Class Magek

constructor

• new Magek(): Magek

  Returns Magek

StaticconfigureCurrentEnv

• configureCurrentEnv(configurator: (config: MagekConfig) => void): void

  Parameters

  • configurator: (config: MagekConfig) => void

  Returns void

Staticconfigure

• configure(
      environment: string,
      configurator: (config: MagekConfig) => void,
  ): void

  Allows to configure the Magek project.

  Parameters

  • environment: string

    The name of the environment you want to configure

  • configurator: (config: MagekConfig) => void

    A function that receives the configuration object to set the values

  Returns void

Staticstart

• start(codeRootPath: string): void

  Initializes the Magek project

  Parameters

  • codeRootPath: string

  Returns void

StaticreadModel

• readModel<TReadModel extends ReadModelInterface>(
      readModelClass: Class<TReadModel>,
  ): Searcher<TReadModel>

  This function returns a "Searcher" configured to search instances of the read model class passed as param. For more information, check the Searcher class.

  Type Parameters

  • TReadModel extends ReadModelInterface

  Parameters

  • readModelClass: Class<TReadModel>

    The class of the read model you what to run searches for

  Returns Searcher<TReadModel>

Staticevents

• events(request: EventSearchParameters): Promise<EventSearchResponse[]>

  Parameters

  • request: EventSearchParameters

  Returns Promise<EventSearchResponse[]>

StaticentitiesIDs

• entitiesIDs(
      entityTypeName: string,
      limit: number,
      afterCursor?: Record<string, string>,
  ): Promise<PaginatedEntitiesIdsResult>

  Parameters

  • entityTypeName: string
  • limit: number
  • OptionalafterCursor: Record<string, string>

  Returns Promise<PaginatedEntitiesIdsResult>

StaticdeleteEvent

• deleteEvent(parameters: EventDeleteParameters): Promise<boolean>

  Parameters

  • parameters: EventDeleteParameters

  Returns Promise<boolean>

Staticentity

• entity<TEntity extends EntityInterface>(
      entityClass: Class<TEntity>,
      entityID: UUID,
  ): Promise<TEntity | undefined>

  Fetches the last known version of an entity

  Type Parameters

  • TEntity extends EntityInterface

  Parameters

  • entityClass: Class<TEntity>

    Name of the entity class

  • entityID: UUID

  Returns Promise<TEntity | undefined>

Static ReadonlyconfiguredEnvironments

Static Readonlyconfig