Class Repository<Data, IdType, IdName, FlatData>

Repository.

Type Parameters

Hierarchy

  • Service
    • Repository

Constructors

constructor

Properties

container

Accessors

datasourceName modelName

Methods

addService count create delete deleteById exists find findById findOne getAdapter getService hasService patch patchById replaceById replaceOrCreate useService

Constructors

constructor

  • new Repository<Data, IdType, IdName, FlatData>(container, modelName): Repository<Data, IdType, IdName, FlatData>

  • Constructor.

    Type Parameters

    • Data extends ModelData = 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

container

container: ServiceContainer

Container.

Accessors

datasourceName

modelName

Methods

addService

  • addService<T>(ctor, ...args): Repository<Data, IdType, IdName, FlatData>

  • Add service.

    Type Parameters

    • T extends object

    Parameters

    • ctor: Constructor<T>
    • Rest ...args: any[]

    Returns Repository<Data, IdType, IdName, FlatData>

count

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>

delete

deleteById

exists

find

findById

findOne

getAdapter

getService

  • getService<T>(ctor, ...args): T

  • Get service.

    Type Parameters

    • T extends object

    Parameters

    • ctor: Constructor<T>
    • Rest ...args: any[]

    Returns T

hasService

  • hasService<T>(ctor): boolean

  • Has service.

    Type Parameters

    • T extends object

    Parameters

    • ctor: Constructor<T>

    Returns boolean

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>

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>

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>

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>

useService

  • useService<T>(ctor, ...args): Repository<Data, IdType, IdName, FlatData>

  • Use service.

    Type Parameters

    • T extends object

    Parameters

    • ctor: Constructor<T>
    • Rest ...args: any[]

    Returns Repository<Data, IdType, IdName, FlatData>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc