Function Projects

Projects<
    TEntity extends EntityInterface,
    TJoinKey extends string | number | symbol,
    TReadModel extends ReadModelInterface,
>(
    originEntity: Class<TEntity>,
    joinKey: JoinKeyType<TEntity, TReadModel>,
    unProject?: UnprojectionMethod<
        TEntity,
        TReadModel,
        PropertyType<TEntity, TJoinKey>,
    >,
): <TReceivedReadModel extends ReadModelInterface>(
    readModelClassOrMethod: Function | Class<TReceivedReadModel>,
    methodNameOrContext: string | Stage3MethodContext,
    methodDescriptor?:
        | ProjectionMethod<TEntity, TReceivedReadModel, keyof TEntity>
        | ProjectionMethodWithEntityConditionalReadModelIdAndReadModel<
            TEntity,
            TReceivedReadModel,
        >,
) => void
Decorator to register a read model method as a projection for a specific entity
Type Parameters
- TEntity extends EntityInterface
- TJoinKey extends string | number | symbol
- TReadModel extends ReadModelInterface
Parameters
- originEntity: Class<TEntity>
  The entity that this method will react to
- joinKey: JoinKeyType<TEntity, TReadModel>
- OptionalunProject: UnprojectionMethod<TEntity, TReadModel, PropertyType<TEntity, TJoinKey>>
Returns <TReceivedReadModel extends ReadModelInterface>(
    readModelClassOrMethod: Function | Class<TReceivedReadModel>,
    methodNameOrContext: string | Stage3MethodContext,
    methodDescriptor?:
        | ProjectionMethod<TEntity, TReceivedReadModel, keyof TEntity>
        | ProjectionMethodWithEntityConditionalReadModelIdAndReadModel<
            TEntity,
            TReceivedReadModel,
        >,
) => void
- Defined in packages/core/src/decorators/projects.ts:53

Function Projects

Type Parameters

Parameters

Settings