Interface KosContainerAwareBase<T>

Base interface providing common container-aware methods and properties. Used internally by both KosContainerAware and KosContainerAwareWithProp.

interface KosContainerAwareBase<T> {
    getModel(id): undefined | T;
    addModel(model): void;
    removeModel(id): void;
    addAll(models): void;
    removeAll(ids): void;
    removeAndDestroy(id): Promise<void>;
    removeAndDestroyAll(ids): Promise<void>;
    models: IKosModelContainer<T>;
    data: T[];
}

Type Parameters

  • T extends IKosDataModel = IKosDataModel

    The type of models contained in the container

Methods

getModel addModel removeModel addAll removeAll removeAndDestroy removeAndDestroyAll

Properties

models data

Methods

getModel

  • getModel(id): undefined | T

  • Retrieves a model from the container by its ID.

    Parameters

    • id: string

      The unique identifier of the model to retrieve

    Returns undefined | T

    The model instance if found, undefined otherwise

addModel

  • addModel(model): void

  • Adds a model to the container.

    Parameters

    • model: T

      The model instance to add

    Returns void

removeModel

  • removeModel(id): void

  • Removes a model from the container by its ID.

    Parameters

    • id: string

      The unique identifier of the model to remove

    Returns void

addAll

  • addAll(models): void

  • Adds multiple models to the container at once.

    Parameters

    • models: T[]

      Array of model instances to add

    Returns void

removeAll

  • removeAll(ids): void

  • Removes multiple models from the container by their IDs.

    Parameters

    • ids: string[]

      Array of unique identifiers of the models to remove

    Returns void

removeAndDestroy

  • removeAndDestroy(id): Promise<void>

  • Removes a model from the container and destroys it. Convenience method that combines removeModel() and destroyKosModel().

    Parameters

    • id: string

      The unique identifier of the model to remove and destroy

    Returns Promise<void>

removeAndDestroyAll

  • removeAndDestroyAll(ids): Promise<void>

  • Removes multiple models from the container and destroys them. Convenience method that combines removeAll() and destroyKosModel().

    Parameters

    • ids: string[]

      Array of unique identifiers of the models to remove and destroy

    Returns Promise<void>

Properties

Readonly models

models: IKosModelContainer<T>

The container instance managing the models. Readonly property that provides access to the KosModelContainer. Compatible with IKosModelHolder interface. Updates automatically when models are added or removed.

data

data: T[]

Reactive array of all model instances in the container. This is the actual array of models, compatible with IKosModelHolder interface. Updates automatically when models are added or removed.

Settings

Member Visibility

Theme

On This Page

getModeladdModelremoveModeladdAllremoveAllremoveAndDestroyremoveAndDestroyAllmodelsdata