Interface KosContainerAware<T>

Interface for models using

Kos Container Aware

decorator.

IMPORTANT: Use TypeScript interface merging to add container management properties to your model class. This provides full type safety and IntelliSense support for all injected container functionality.

Interface Merging Pattern

// 1. Declare interface merging BEFORE the class
interface MyContainerModelImpl extends KosContainerAware<ItemModel> {}

// 2. Apply decorator and implement the class
@kosModel("my-container-model")
@kosContainerAware<ItemModel>()
export class MyContainerModelImpl implements IKosDataModel {
  // All container properties are now available with full type safety
}
Copy

Custom Container Property Name

When using a custom containerProperty name, use KosContainerAwareWithProp:

// For custom container property name
interface DeviceManagerImpl extends KosContainerAwareWithProp<DeviceModel, "devices"> {}

@kosContainerAware<DeviceModel>({ containerProperty: "devices" })
class DeviceManagerImpl implements IKosDataModel {
  // Access via: this.devices instead of this.container
}
Copy

Injected Properties and Methods

The decorator automatically injects the following members (configurable via options):

• container: Core KosModelContainer instance for direct access (or custom name via containerProperty)
• getModel(id): Retrieve a model by ID from the container
• addModel(model): Add a model to the container
• removeModel(id): Remove a model from the container by ID (does not destroy)
• addAll(models): Add multiple models to the container at once
• removeAll(ids): Remove multiple models from the container by IDs (does not destroy)
• removeAndDestroy(id): Remove a model from the container and destroy it
• removeAndDestroyAll(ids): Remove multiple models from the container and destroy them
• models: Readonly KosModelContainer instance (compatible with IKosModelHolder)
• data: Reactive array of all model instances (compatible with IKosModelHolder)

All injected getters are reactive and will automatically update UI components when container contents change.

Example

// Basic usage with minimal configuration
interface DeviceContainerModelImpl extends KosContainerAware<DeviceModel> {}

@kosModel("device-container-model")
@kosContainerAware<DeviceModel>()
class DeviceContainerModelImpl implements IKosDataModel {
  constructor(modelId: string, options: ContainerOptions, context: KosCreationContext) {
    this.id = modelId;
    // Container automatically injected with parentId: modelId
  }

  // Use injected methods
  addDevice(device: DeviceModel): void {
    this.addModel(device); // Method injected by decorator
  }

  // Use injected reactive getters
  get deviceCount(): number {
    return this.data.length; // Reactive array getter injected by decorator
  }
}
Copy

Example

// Advanced usage with indexing and custom configuration
interface UserContainerModelImpl extends KosContainerAware<UserModel> {}

@kosModel("user-container-model")
@kosContainerAware<UserModel>({
  containerOptions: {
    indexMap: {
      byRole: "role",
      byDepartment: "department",
      active: (user) => user.status === "active"
    },
    sortKey: "lastName"
  }
})
class UserContainerModelImpl implements IKosDataModel {
  // Access indexed data via injected container
  getActiveUsers(): UserModel[] {
    return this.container.getIndexByKey("active", true);
  }

  getUsersByRole(role: string): UserModel[] {
    return this.container.getIndexByKey("byRole", role);
  }
}
Copy

See

• kosContainerAware - The decorator function
• KosContainerAwareOptions - Configuration options