API docs: repository.definecrudrepositoryclass

Page Contents

Home > @loopback/repository > defineCrudRepositoryClass

defineCrudRepositoryClass() function

Create (define) an entity CRUD repository class for the given model. This function always uses DefaultCrudRepository as the base class, use defineRepositoryClass if you want to use your own base repository.

Signature:

export declare function defineCrudRepositoryClass<E extends Entity, IdType, Relations extends object>(entityClass: typeof Entity & {
    prototype: E;
}): ModelRepositoryClass<E, DefaultCrudRepository<E, IdType, Relations>>;

Parameters

Parameter	Type	Description
entityClass	typeof Entity & { prototype: E; }	An entity class such as `Product`.

Returns:

ModelRepositoryClass<E, DefaultCrudRepository<E, IdType, Relations>>

Example

const ProductRepository = defineCrudRepositoryClass<
  Product,
  typeof Product.prototype.id,
  ProductRelations
>(Product);