Class ResolutionTree

Resolution tree

Index

Constructors

Methods

addAllDocumentsOfACollection addDocument addDocuments getAllDocuments getAllTypedDocuments getDocument getTypedDocument

Constructors

constructor

new ResolutionTree(): ResolutionTree
Creates a ResolutionTree

Returns ResolutionTree
- Defined in packages/firestorm/src/repositories/toolkit/include-resolver/resolution-tree/resolution-tree.ts:16

Methods

addAllDocumentsOfACollection

addAllDocumentsOfACollection<T extends IFirestormModel>(
path: PathLike,
models: Iterable<T>,
): void
Adds all the documents of a collection to the resolution tree
Type Parameters
- T extends IFirestormModel
Parameters
- path: PathLike
  Full path to the collection
- models: Iterable<T>
  Models to add
Returns void
- Defined in packages/firestorm/src/repositories/toolkit/include-resolver/resolution-tree/resolution-tree.ts:76

addDocument

addDocument<T extends IFirestormModel>(path: PathLike, model: T): void
Adds a document to the resolution tree
Type Parameters
- T extends IFirestormModel
Parameters
- path: PathLike
  Full path to the document
- model: T
  Model to add
Returns void
- Defined in packages/firestorm/src/repositories/toolkit/include-resolver/resolution-tree/resolution-tree.ts:23

addDocuments

addDocuments<T extends IFirestormModel>(
collectionPath: PathLike,
models: T[],
): void
Adds multiple documents to the resolution tree
Type Parameters
- T extends IFirestormModel
Parameters
- collectionPath: PathLike
  Full path to the collection this document belongs to
- models: T[]
  Models to add
Returns void
- Defined in packages/firestorm/src/repositories/toolkit/include-resolver/resolution-tree/resolution-tree.ts:60

getAllDocuments

getAllDocuments(
pathLike: PathLike,
ignoreFullness?: boolean,
): IFirestormModel[] | null
Gets all documents of a collection in the resolution tree
Parameters
- pathLike: PathLike
  Path to the collection
- ignoreFullness: boolean = false
  If false (default), only gets the documents if the collection node has all the documents of the DB. If true, gets all the documents in the collection even if it may not be all the documents in the DB
Returns IFirestormModel[] | null
Gets all the document of the collection or null if the collection isn't full and ignoreFullness is not raised.
- Defined in packages/firestorm/src/repositories/toolkit/include-resolver/resolution-tree/resolution-tree.ts:150

getAllTypedDocuments

getAllTypedDocuments<T extends IFirestormModel>(
    pathLike: PathLike,
    type: Type<T>,
    ignoreFullness?: boolean,
): T & IMandatoryFirestormModel[] | null
Gets all documents of a collection in the resolution tree with the type requested
Type Parameters
- T extends IFirestormModel
  Type of the document
Parameters
- pathLike: PathLike
  Path to the collection
- type: Type<T>
  Type of the document
- ignoreFullness: boolean = false
  If false (default), only gets the documents if the collection node has all the documents of the DB. If true, gets all the documents in the collection even if it may not be all the documents in the DB
Returns T & IMandatoryFirestormModel[] | null
Gets all the document of the collection or null if the collection isn't full and ignoreFullness is not raised.
- Defined in packages/firestorm/src/repositories/toolkit/include-resolver/resolution-tree/resolution-tree.ts:179

getDocument

getDocument(pathLike: PathLike): IFirestormModel | null
Gets a document in the resolution tree
Parameters
- pathLike: PathLike
  Path to the document
Returns IFirestormModel | null
The document if it exists or null if it doesn't
- Defined in packages/firestorm/src/repositories/toolkit/include-resolver/resolution-tree/resolution-tree.ts:107

getTypedDocument

getTypedDocument<T extends IFirestormModel>(
pathLike: PathLike,
type: Type<T>,
): T | null
Gets a typed document in the resolution tree
Type Parameters
- T extends IFirestormModel
  Type of the document
Parameters
- pathLike: PathLike
  Path to the document
- type: Type<T>
  Type of the document
Returns T | null
The document if it exists AND is of the type provided or null if it doesn't
- Defined in packages/firestorm/src/repositories/toolkit/include-resolver/resolution-tree/resolution-tree.ts:130