Class IncludeResolver<T_model, P>

Class in charge of resolving includes in model loading. Includes are subdocuments of a main document loaded alongside it

Type Parameters

T_model extends FirestormModel
P extends Partial<T_model>

Index

Constructors

Properties

firestorm includers requests resolutionTree targetType

Methods

includeFor resolveAsync

Constructors

constructor

new IncludeResolver<T_model extends IFirestormModel, P extends Partial<T_model>>(
firestorm: Firestorm,
type: Type<P>,
): IncludeResolver<T_model, P>
Creates an IncludeResolver
Type Parameters
- T_model extends IFirestormModel
- P extends Partial<T_model>
Parameters
- firestorm: Firestorm
  FirestORM instance used to access the DB
- type: Type<P>
  Type of model
Returns IncludeResolver<T_model, P>
- Defined in packages/firestorm/src/repositories/toolkit/include-resolver/include-resolver.ts:89

Properties

`Protected` `Readonly`firestorm

firestorm: Firestorm

FirestORM instance used to access the DB

`Protected`includers

includers: IncludeFor<T_model, P>[] = []

Main models that may request subdocuments

`Protected`requests

requests: Request<any>[] = []

List of requests for documents

`Protected`resolutionTree

resolutionTree: ResolutionTree = ...

Documents already loaded

`Protected`targetType

targetType: Type<P>

Type of the document requesting includes

Methods

includeFor

includeFor(includeFor: IncludeFor<T_model, P>): void
Adds one document inclusion
Parameters
- includeFor: IncludeFor<T_model, P>
  Document to include with its path
Returns void
- Defined in packages/firestorm/src/repositories/toolkit/include-resolver/include-resolver.ts:97
includeFor(includeFor: IncludeFor<T_model, P>[]): void
Adds multiple document inclusions
Parameters
- includeFor: IncludeFor<T_model, P>[]
  Documents to include with their path
Returns void
- Defined in packages/firestorm/src/repositories/toolkit/include-resolver/include-resolver.ts:102

resolveAsync

resolveAsync(includes: RelationshipIncludes<T_model>): Promise<void>
Resolves the includes for the includes
Parameters
- includes: RelationshipIncludes<T_model>
  Includes to resolve
Returns Promise<void>
- Defined in packages/firestorm/src/repositories/toolkit/include-resolver/include-resolver.ts:115