@typescript-eda/domain/src/domain/entity.ts

Core domain primitives for event-driven architecture

// Copyright 2021-2024 The Connect Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

/**
 * @fileoverview This file defines the Entity class, a base class for objects that have a distinct identity.
 * @author rydnr
 * @module domain/entity
 */

import { ValueObject } from './value-object';

/**
 * Represents an entity, which is an object with a distinct identity that persists through different states.
 * @template T The type of the properties of the entity.
 */
export abstract class Entity<T> extends ValueObject<T> {
  /**
   * Creates an instance of Entity.
   * @param {T} props The properties of the entity.
   * @protected
   */
  protected constructor(protected readonly props: T) {
    super(props);
  }

  public get<K extends keyof T>(key: K): T[K] {
    return this.props[key];
  }
}