Interface EntityWithId

interface EntityWithId {
    id: string;
    hasId(): boolean;
    recover(options?: SaveOptions): Promise<EntityWithId>;
    reload(): Promise<void>;
    remove(options?: RemoveOptions): Promise<EntityWithId>;
    save(options?: SaveOptions): Promise<EntityWithId>;
    softRemove(options?: SaveOptions): Promise<EntityWithId>;
}

Hierarchy

  • BaseEntity
    • EntityWithId

Properties

id

Methods

hasId recover reload remove save softRemove

Properties

id

id: string

Methods

hasId

  • hasId(): boolean

    Checks if entity has an id. If entity composite compose ids, it will check them all.

    Returns boolean

recover

  • recover(options?: SaveOptions): Promise<EntityWithId>

    Recovers a given entity in the database.

    Parameters

    • Optionaloptions: SaveOptions

    Returns Promise<EntityWithId>

reload

  • reload(): Promise<void>

    Reloads entity data from the database.

    Returns Promise<void>

remove

  • remove(options?: RemoveOptions): Promise<EntityWithId>

    Removes current entity from the database.

    Parameters

    • Optionaloptions: RemoveOptions

    Returns Promise<EntityWithId>

save

  • save(options?: SaveOptions): Promise<EntityWithId>

    Saves current entity in the database. If entity does not exist in the database then inserts, otherwise updates.

    Parameters

    • Optionaloptions: SaveOptions

    Returns Promise<EntityWithId>

softRemove

  • softRemove(options?: SaveOptions): Promise<EntityWithId>

    Records the delete date of current entity.

    Parameters

    • Optionaloptions: SaveOptions

    Returns Promise<EntityWithId>

Settings

Member Visibility

On This Page

Properties
Methods