db/repository

Documentation

• source: db/repository.ts

Overview

Classes

Repository

getEntityName()

getEntityName(): string;

Returns

• Type: string
• Description:

getTableName()

getTableName(): string;

Returns

• Type: string
• Description:

getIdName()

getIdName(): string;

Returns

• Type: string
• Description:

getIdColumn()

getIdColumn(): string;

Returns

• Type: string
• Description:

findAll()

Finds all entities matching the given options.

findAll(options: Options): void;

Parameter	Type	Description
options	Options

Returns

• Type: void
• Description:

findById()

Finds a single entity by its primary key ID.

findById(id: any, options: Options): T;

Parameter	Type	Description
id	any
options	Options

Returns

• Type: T
• Description:

create()

Creates a new entity in the database.

create(entity: T): void;

Parameter	Type	Description
entity	T

Returns

• Type: void
• Description: The generated ID (string or number).

update()

Updates an existing entity. The entity must contain the primary key.

update(entity: T): void;

Parameter	Type	Description
entity	T

Returns

• Type: void
• Description:

upsert()

Creates the entity if the ID is null/undefined, otherwise updates it. If an ID is provided but the entity doesn't exist, it creates it.

upsert(entity: T): void;

Parameter	Type	Description
entity	T

Returns

• Type: void
• Description: The entity's ID.

deleteById()

Deletes an entity by its primary key ID.

deleteById(id: any): void;

Parameter	Type	Description
id	any

Returns

• Type: void
• Description:

count()

Counts the number of entities matching the given options.

count(options: Options): number;

Parameter	Type	Description
options	Options

Returns

• Type: number
• Description:

triggerEvent()

Protected method intended for subclass overriding or internal event handling.

triggerEvent(_data: EntityEvent): Promise;

Parameter	Type	Description
_data	EntityEvent

Returns

• Type: Promise
• Description: