Class Repository<Data, IdType, IdName, FlatData>

Repository.

Type Parameters

Data extends object = ModelData
IdType extends ModelId = ModelId
IdName extends string = DEFAULT_PRIMARY_KEY_PROPERTY_NAME
FlatData extends ModelData = Flatten<Data>

Hierarchy

Service
- Repository

Index

Constructors

constructor

new Repository<Data, IdType, IdName, FlatData>(container, modelName): Repository<Data, IdType, IdName, FlatData>
Constructor.
Type Parameters
- Data extends object = ModelData
- IdType extends unknown = unknown
- IdName extends string = "id"
- FlatData extends ModelData = {
  [k in string | number | symbol]: Data[k]
  }
Parameters
- container: ServiceContainer
- modelName: string
Returns Repository<Data, IdType, IdName, FlatData>
Overrides Service.constructor
- Defined in src/repository/repository.d.ts:44

Properties

`Private` `Optional` _Data

_Data?: Data

`Private` `Optional` _FlatData

_FlatData?: FlatData

`Private` `Optional` _IdName

_IdName?: IdName

`Private` `Optional` _IdType

_IdType?: IdType

container

container: ServiceContainer

Container.

Accessors

datasourceName

get datasourceName(): string
Datasource name.

Returns string
- Defined in src/repository/repository.d.ts:36

modelName

get modelName(): string
Model name.

Returns string
- Defined in src/repository/repository.d.ts:31

Methods

addService

addService<T>(ctor, ...args): this
Add service.
Type Parameters
- T extends object
Parameters
- ctor: Constructor<T>
- Rest ...args: any[]
Returns this
Inherited from Service.addService
- Defined in node_modules/@e22m4u/js-service/src/service.d.ts:46

count

count(where?): Promise<number>
Count.
Parameters
- Optional where: WhereClause
Returns Promise<number>
- Defined in src/repository/repository.d.ts:158

create

create(data, filter?): Promise<FlatData>
Create.
Parameters
- data: {
      [k in string | number | symbol]: (FlatData extends {
              [K in string]: any
          }
          ? PartialBy<FlatData, IdName>
          : FlatData)[k]
  }
- Optional filter: ItemFilterClause
Returns Promise<FlatData>
- Defined in src/repository/repository.d.ts:57

delete

delete(where?): Promise<number>
Delete.
Parameters
- Optional where: WhereClause
Returns Promise<number>
- Defined in src/repository/repository.d.ts:137

deleteById

deleteById(id): Promise<boolean>
Delete by id.
Parameters
- id: IdType
Returns Promise<boolean>
- Defined in src/repository/repository.d.ts:144

exists

exists(id): Promise<boolean>
Exists.
Parameters
- id: IdType
Returns Promise<boolean>
- Defined in src/repository/repository.d.ts:151

find

find(filter?): Promise<FlatData[]>
Find.
Parameters
- Optional filter: FilterClause
Returns Promise<FlatData[]>
- Defined in src/repository/repository.d.ts:115

findById

findById(id, filter?): Promise<FlatData>
Find by id.
Parameters
- id: IdType
- Optional filter: ItemFilterClause
Returns Promise<FlatData>
- Defined in src/repository/repository.d.ts:130

findOne

findOne(filter?): Promise<undefined | FlatData>
Find one.
Parameters
- Optional filter: FilterClause
Returns Promise<undefined | FlatData>
- Defined in src/repository/repository.d.ts:122

getAdapter

getAdapter(): Promise<Adapter>
Get adapter.

Returns Promise<Adapter>
- Defined in src/repository/repository.d.ts:49

getService

getService<T>(ctor, ...args): T
Get service.
Type Parameters
- T extends object
Parameters
- ctor: Constructor<T>
- Rest ...args: any[]
Returns T
Inherited from Service.getService
- Defined in node_modules/@e22m4u/js-service/src/service.d.ts:26

hasService

hasService<T>(ctor): boolean
Has service.
Type Parameters
- T extends object
Parameters
- ctor: Constructor<T>
Returns boolean
Inherited from Service.hasService
- Defined in node_modules/@e22m4u/js-service/src/service.d.ts:36

patch

patch(data, where?): Promise<number>
Patch.
Parameters
- data: {
  [k in string | number | symbol]: Partial<Omit<Data, IdName>>[k]
  }
- Optional where: WhereClause
Returns Promise<number>
- Defined in src/repository/repository.d.ts:92

patchById

patchById(id, data, filter?): Promise<FlatData>
Patch by id.
Parameters
- id: IdType
- data: {
  [k in string | number | symbol]: Partial<Omit<Data, IdName>>[k]
  }
- Optional filter: ItemFilterClause
Returns Promise<FlatData>
- Defined in src/repository/repository.d.ts:104

replaceById

replaceById(id, data, filter?): Promise<FlatData>
Replace by id.
Parameters
- id: IdType
- data: {
  [k in string | number | symbol]: Omit<FlatData, IdName>[k]
  }
- Optional filter: ItemFilterClause
Returns Promise<FlatData>
- Defined in src/repository/repository.d.ts:69

replaceOrCreate

replaceOrCreate(data, filter?): Promise<FlatData>
Replace or create.
Parameters
- data: {
      [k in string | number | symbol]: (Data extends {
              [K in string]: any
          }
          ? PartialBy<Data, IdName>
          : Data)[k]
  }
- Optional filter: ItemFilterClause
Returns Promise<FlatData>
- Defined in src/repository/repository.d.ts:81

useService

useService<T>(ctor, ...args): this
Use service.
Type Parameters
- T extends object
Parameters
- ctor: Constructor<T>
- Rest ...args: any[]
Returns this
Inherited from Service.useService
- Defined in node_modules/@e22m4u/js-service/src/service.d.ts:57

Class Repository<Data, IdType, IdName, FlatData>

Type Parameters

Data extends object = ModelData

IdType extends ModelId = ModelId

IdName extends string = DEFAULT_PRIMARY_KEY_PROPERTY_NAME

FlatData extends ModelData = Flatten<Data>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Data extends object = ModelData

IdType extends unknown = unknown

IdName extends string = "id"

FlatData extends ModelData = { [k in string | number | symbol]: Data[k]}

Parameters

container: ServiceContainer

modelName: string

Returns Repository<Data, IdType, IdName, FlatData>

Properties

Private Optional _Data

Private Optional _FlatData

Private Optional _IdName

Private Optional _IdType

container

Accessors

datasourceName

Returns string

modelName

Returns string

Methods

addService

Type Parameters

T extends object

Parameters

ctor: Constructor<T>

Rest ...args: any[]

Returns this

count

Parameters

Optional where: WhereClause

Returns Promise<number>

create

Parameters

data: { [k in string | number | symbol]: (FlatData extends { [K in string]: any } ? PartialBy<FlatData, IdName> : FlatData)[k]}

Optional filter: ItemFilterClause

Returns Promise<FlatData>

delete

Parameters

Optional where: WhereClause

Returns Promise<number>

deleteById

Parameters

id: IdType

Returns Promise<boolean>

exists

Parameters

id: IdType

Returns Promise<boolean>

find

Parameters

Optional filter: FilterClause

Returns Promise<FlatData[]>

findById

Parameters

id: IdType

Optional filter: ItemFilterClause

Returns Promise<FlatData>

findOne

Parameters

Optional filter: FilterClause

Returns Promise<undefined | FlatData>

getAdapter

Returns Promise<Adapter>

getService

Type Parameters

FlatData extends ModelData = {
[k in string | number | symbol]: Data[k]
}

`Private` `Optional` _Data

`Private` `Optional` _FlatData

`Private` `Optional` _IdName

`Private` `Optional` _IdType

`Rest` ...args: any[]

`Optional` where: WhereClause

data: {
[k in string | number | symbol]: (FlatData extends {
[K in string]: any
}
? PartialBy<FlatData, IdName>
: FlatData)[k]
}

`Optional` filter: ItemFilterClause

`Optional` where: WhereClause

`Optional` filter: FilterClause

`Optional` filter: ItemFilterClause

`Optional` filter: FilterClause

`Rest` ...args: any[]

data: {
[k in string | number | symbol]: Partial<Omit<Data, IdName>>[k]
}

`Optional` where: WhereClause

data: {
[k in string | number | symbol]: Partial<Omit<Data, IdName>>[k]
}

`Optional` filter: ItemFilterClause

data: {
[k in string | number | symbol]: Omit<FlatData, IdName>[k]
}

`Optional` filter: ItemFilterClause

data: {
[k in string | number | symbol]: (Data extends {
[K in string]: any
}
? PartialBy<Data, IdName>
: Data)[k]
}

`Optional` filter: ItemFilterClause

`Rest` ...args: any[]