Interface IRepository<Entity, Id>

Generic repository providing CRUD operations over an entity type.

Since

0.1.0

interface IRepository<Entity, Id extends EntityKey = string> {
    count(options?: CountOptions): Promise<number>;
    create(data: Partial<Entity>): Promise<Entity>;
    delete(id: Id): Promise<boolean>;
    deleteWhere?(id: Id, where: WritePrecondition): Promise<boolean>;
    exists(id: Id): Promise<boolean>;
    findAll(options?: FindOptions): Promise<Entity[]>;
    findById(id: Id): Promise<Entity | null>;
    findOne(options?: FindOptions): Promise<Entity | null>;
    findPage(options: FindOptions): Promise<Page<Entity>>;
    update(id: Id, data: Partial<Entity>): Promise<Entity>;
    updateWhere?(
        id: Id,
        where: WritePrecondition,
        data: Partial<Entity>,
    ): Promise<Entity | null>;
}

Type Parameters

Entity
The entity shape the repository manages
Id extends EntityKey = string
Primary key type, constrained to EntityKey (scalar string/number or composite record). Defaults to string.

Implemented by

BaseRepository

Index

Methods

count create delete deleteWhere? exists findAll findById findOne findPage update updateWhere?

Methods

count

count(options?: CountOptions): Promise<number>
Count entities with optional filtering.
Parameters
- Optionaloptions: CountOptions
  Count options (equality and portable expression filters)
Returns Promise<number>
Matching entity count

Since
0.1.0
- Defined in packages/database-plugin/src/interfaces/index.ts:171

create

create(data: Partial<Entity>): Promise<Entity>
Insert a new entity.
Parameters
- data: Partial<Entity>
  Partial entity (at minimum the required fields)
Returns Promise<Entity>
The persisted entity (with generated fields populated)

Since
0.1.0
- Defined in packages/database-plugin/src/interfaces/index.ts:108

delete

delete(id: Id): Promise<boolean>
Delete an entity by primary key.
Parameters
- id: Id
  Primary key of the entity to delete
Returns Promise<boolean>
true if an entity was deleted, false if not found

Since
0.1.0
- Defined in packages/database-plugin/src/interfaces/index.ts:128

`Optional`deleteWhere

deleteWhere?(id: Id, where: WritePrecondition): Promise<boolean>
Delete only while the key and every equality precondition match. Optional permanently. BaseRepository rejects before I/O if the source lacks it.
Parameters
- id: Id
  Primary key
- where: WritePrecondition
  Non-empty string/number equality map on stored values
Returns Promise<boolean>
Whether the conditional delete applied

Throws
For an invalid predicate or unsupported source

Since
0.9.0
- Defined in packages/database-plugin/src/interfaces/index.ts:153

exists

exists(id: Id): Promise<boolean>
Check whether an entity with the given primary key exists.
Parameters
- id: Id
  Primary key value
Returns Promise<boolean>
true when the entity exists

Since
0.1.0
- Defined in packages/database-plugin/src/interfaces/index.ts:162

findAll

findAll(options?: FindOptions): Promise<Entity[]>
Fetch entities with optional filtering, sorting, and pagination.
Parameters
- Optionaloptions: FindOptions
  Find options (filter, sort, paginate)
Returns Promise<Entity[]>
Matching entities

Since
0.1.0
- Defined in packages/database-plugin/src/interfaces/index.ts:90

findById

findById(id: Id): Promise<Entity | null>
Fetch a single entity by its primary key.
Parameters
- id: Id
  Primary key value
Returns Promise<Entity | null>
The entity or null when not found

Since
0.1.0
- Defined in packages/database-plugin/src/interfaces/index.ts:81

findOne

findOne(options?: FindOptions): Promise<Entity | null>
Fetch the first entity matching the optional filter.
Parameters
- Optionaloptions: FindOptions
  Find options; at most one matching entity is returned
Returns Promise<Entity | null>
The first matching entity, or null when none matches

Since
0.2.0
- Defined in packages/database-plugin/src/interfaces/index.ts:99

findPage

findPage(options: FindOptions): Promise<Page<Entity>>
Find a page of entities by cursor pagination.
Parameters
- options: FindOptions
  Find options, optionally carrying a cursor position
Returns Promise<Page<Entity>>
The page of entities plus a nextCursor that is null when the page is the last

Throws
When the bound data source lacks findPage

Since
0.2.0
- Defined in packages/database-plugin/src/interfaces/index.ts:181

update

update(id: Id, data: Partial<Entity>): Promise<Entity>
Update an existing entity by primary key.
Parameters
- id: Id
  Primary key of the entity to update
- data: Partial<Entity>
  Fields to merge into the entity
Returns Promise<Entity>
The updated entity

Throws
If the entity does not exist

Since
0.1.0
- Defined in packages/database-plugin/src/interfaces/index.ts:119

`Optional`updateWhere

updateWhere?(
    id: Id,
    where: WritePrecondition,
    data: Partial<Entity>,
): Promise<Entity | null>
Update only while the key and every equality precondition match. Optional permanently. BaseRepository rejects before I/O if the source lacks it.
Parameters
- id: Id
  Primary key
- where: WritePrecondition
  Non-empty string/number equality map on stored values
- data: Partial<Entity>
  Non-empty update payload
Returns Promise<Entity | null>
Updated entity, or null for a missing key or predicate mismatch

Throws
For an invalid predicate or unsupported source

Since
0.9.0
- Defined in packages/database-plugin/src/interfaces/index.ts:141

Interface IRepository<Entity, Id>

Since

Type Parameters

Implemented by

Index

Methods

Methods

count

Parameters

Returns Promise<number>

Since

create

Parameters

Returns Promise<Entity>

Since

delete

Parameters

Returns Promise<boolean>

Since

OptionaldeleteWhere

Parameters

Returns Promise<boolean>

Throws

Since

exists

Parameters

Returns Promise<boolean>

Since

findAll

Parameters

Returns Promise<Entity[]>

Since

findById

Parameters

Returns Promise<Entity | null>

Since

findOne

Parameters

Returns Promise<Entity | null>

Since

findPage

Parameters

Returns Promise<Page<Entity>>

Throws

Since

update

Parameters

Returns Promise<Entity>

Throws

Since

OptionalupdateWhere

Parameters

Returns Promise<Entity | null>

Throws

Since

Settings

On This Page

`Optional`deleteWhere

`Optional`updateWhere