Class IncludeFor<T_model, T_partial>

Includer that is used by the include resolver to tell which models are requesting other documents and were they are.

Type Parameters

T_model extends FirestormModel
The full type of the model
T_partial extends Partial<T_model>
The partial version of the model

Index

Constructors

Properties

collectionPath documentPath model

Constructors

constructor

new IncludeFor<
    T_model extends IFirestormModel,
    T_partial extends Partial<T_model>,
>(
    model: T_partial,
    collectionPath: PathLike,
): IncludeFor<T_model, T_partial>
Creates an includer
Type Parameters
- T_model extends IFirestormModel
  The full type of the model
- T_partial extends Partial<T_model>
  The partial version of the model
Parameters
- model: T_partial
  Model that requests includes
- collectionPath: PathLike
  Path to the collection of the model
Returns IncludeFor<T_model, T_partial>
- Defined in packages/firestorm/src/repositories/toolkit/include-resolver/include-for.ts:25

Properties

`Readonly`collectionPath

collectionPath: Path

The path to the collection this document is in

`Readonly`documentPath

documentPath: Path

The full path to the document

model

model: T_partial

Model that requests includes