@loopback/repository/dist/relations/has-one/has-one.repository-factory.d.ts

Define and implement a common set of interfaces for interacting with databases

import { Entity } from '../../model';
import { EntityCrudRepository } from '../../repositories';
import { Getter, HasOneDefinition, InclusionResolver } from '../relation.types';
import { HasOneRepository } from './has-one.repository';
export interface HasOneRepositoryFactory<Target extends Entity, ForeignKeyType> {
    /**
     * Invoke the function to obtain HasOneRepository.
     */
    (fkValue: ForeignKeyType): HasOneRepository<Target>;
    /**
     * Use `resolver` property to obtain an InclusionResolver for this relation.
     */
    inclusionResolver: InclusionResolver<Entity, Target>;
}
/**
 * Enforces a constraint on a repository based on a relationship contract
 * between models. For example, if a Customer model is related to an Address model
 * via a HasOne relation, then, the relational repository returned by the
 * factory function would be constrained by a Customer model instance's id(s).
 *
 * If the target model is polymorphic, i.e. stored within different repositories,
 * supply the targetRepositoryGetter with a dictionary in the form of {[typeName: string]: repositoryGetter}
 *
 * @param relationMetadata - The relation metadata used to describe the
 * relationship and determine how to apply the constraint.
 * @param targetRepositoryGetter - The repository or a dictionary of classname - repository,
 * which represents the target model of a relation attached to a datasource.
 * For the dictionary, the key is the class name of the concrete class the the polymorphic model.
 * @returns The factory function which accepts a foreign key value to constrain
 * the given target repository
 */
export declare function createHasOneRepositoryFactory<Target extends Entity, TargetID, ForeignKeyType>(relationMetadata: HasOneDefinition, targetRepositoryGetter: Getter<EntityCrudRepository<Target, TargetID>> | {
    [repoType: string]: Getter<EntityCrudRepository<Target, TargetID>>;
}): HasOneRepositoryFactory<Target, ForeignKeyType>;