@ngxs-labs/entity-state/lib/actions/type-alias.d.ts

<p align="center"> <img src="https://raw.githubusercontent.com/ngxs-labs/emitter/master/docs/assets/logo.png"> </p>

/**
 * An EntitySelector determines which entities will be affected.
 * Can be one of the following:
 * - a single ID in form of a string
 * - multiple IDs in form of an array of strings
 * - a predicate function that returns `true` for entities to be selected
 */
export declare type EntitySelector<T> = string | string[] | ((entity: T) => boolean);
/**
 * An Updater will be applied to the current entity, before onUpdate is run with its result.
 * Can be one of the following:
 * - a partial object of an entity
 * - a function that takes the current entity and returns a partially updated entity
 * @see EntityState#onUpdate
 */
export declare type Updater<T> = Partial<T> | ((entity: Readonly<T>) => Partial<T>);
/**
 * Interface for an object that has a payload field of type T
 */
export interface Payload<T> {
    payload: T;
}
/**
 * Enum that contains all existing Actions for the Entity State adapter.
 */
export declare enum EntityActionType {
    Add = "add",
    CreateOrReplace = "createOrReplace",
    Update = "update",
    UpdateAll = "updateAll",
    UpdateActive = "updateActive",
    Remove = "remove",
    RemoveAll = "removeAll",
    RemoveActive = "removeActive",
    SetLoading = "setLoading",
    SetError = "setError",
    SetActive = "setActive",
    ClearActive = "clearActive",
    Reset = "reset",
    GoToPage = "goToPage",
    SetPageSize = "setPageSize"
}