Class: MongoDBDependencyGraph

Represents the base class for implementing a concrete dependency graph.

Hierarchy

• DependencyGraphBase

  ↳ MongoDBDependencyGraph

Table of contents

Constructors

• constructor

Properties

• editorExtractor
• payload
• schema

Accessors

• collection

Methods

• addDependency
• deleteResource
• extractDependenciesFromDoc
• getDependenciesForCollection
• getDependenciesOfCollection
• getDependsOnCollection
• isDependency
• isDependencyForAnyResourceOfCollection
• isDirectDependency
• populate
• purgeDependentOn
• safeFindOne
• setEditorExtractor
• setPayload
• setSchema
• compareResources

Constructors

constructor

• new MongoDBDependencyGraph(): MongoDBDependencyGraph

Returns

MongoDBDependencyGraph

Inherited from

DependencyGraphBase.constructor

Properties

editorExtractor

• Protected Optional editorExtractor: EditorExtractor

The function that takes care of extracting the dependencies from a field of type richText.

Inherited from

DependencyGraphBase.editorExtractor

Defined in

src/dependency-graph/base.ts:42

---

payload

• Protected payload: Payload

Payload instance

Inherited from

DependencyGraphBase.payload

Defined in

src/dependency-graph/base.ts:37

---

schema

• Protected schema: DependencyGraphSchema

Schema of the dependency graph

Inherited from

DependencyGraphBase.schema

Defined in

src/dependency-graph/base.ts:32

Accessors

collection

• get collection(): Collection\<AnyObject>

Get collection and if doesn't exist, it will create it

Returns

Collection\<AnyObject>

Defined in

src/dependency-graph/mongodb.ts:328

Methods

addDependency

▸ addDependency(source, target): Promise\<void>

Add target as a direct dependency of source.

Parameters

Name	Type
source	DependencyGraphResource
target	DependencyGraphResource

Returns

Promise\<void>

Overrides

DependencyGraphBase.addDependency

Defined in

src/dependency-graph/mongodb.ts:29

---

deleteResource

▸ deleteResource(resource): Promise\<void>

Deletes a resource from the dependency graph.

Parameters

Name	Type
resource	DependencyGraphResource

Returns

Promise\<void>

Overrides

DependencyGraphBase.deleteResource

Defined in

src/dependency-graph/mongodb.ts:10

---

extractDependenciesFromDoc

▸ extractDependenciesFromDoc(source, doc, schemas): Promise\<void>

Used to extract dependencies from a document based on schemas. The function will automatically populate the dependency graph.

Parameters

Name	Type
source	DependencyGraphResource
doc	any
schemas	DependencySchema[]

Returns

Promise\<void>

Inherited from

DependencyGraphBase.extractDependenciesFromDoc

Defined in

src/dependency-graph/base.ts:199

---

getDependenciesForCollection

▸ getDependenciesForCollection(resource, collection): Promise\<DependencyGraphResource[]>

Get dependencies from resource that is of collection. This function traverses from bottom to up, using dependecyFor.

Parameters

Name	Type
resource	DependencyGraphResource
collection	string

Returns

Promise\<DependencyGraphResource[]>

Overrides

DependencyGraphBase.getDependenciesForCollection

Defined in

src/dependency-graph/mongodb.ts:216

---

getDependenciesOfCollection

▸ getDependenciesOfCollection(resource, collection): Promise\<DependencyGraphResource[]>

Get dependencies of resource that is of collection

Parameters

Name	Type
resource	DependencyGraphResource
collection	string

Returns

Promise\<DependencyGraphResource[]>

Overrides

DependencyGraphBase.getDependenciesOfCollection

Defined in

src/dependency-graph/mongodb.ts:202

---

getDependsOnCollection

▸ getDependsOnCollection(resource, collection): Promise\<DependencyGraphResource[]>

Get dependencies from resource that is of collection. This function traverses from up to bottom, using dependentOn.

Parameters

Name	Type
resource	DependencyGraphResource
collection	string

Returns

Promise\<DependencyGraphResource[]>

Overrides

DependencyGraphBase.getDependsOnCollection

Defined in

src/dependency-graph/mongodb.ts:270

---

isDependency

▸ isDependency(source, target): Promise\<boolean>

Is target a dependency for source?

Parameters

Name	Type
source	DependencyGraphResource
target	DependencyGraphResource

Returns

Promise\<boolean>

Overrides

DependencyGraphBase.isDependency

Defined in

src/dependency-graph/mongodb.ts:110

---

isDependencyForAnyResourceOfCollection

▸ isDependencyForAnyResourceOfCollection(target, collection): Promise\<boolean>

Is target a dependency for any resource of collection given?

Parameters

Name	Type
target	DependencyGraphResource
collection	string

Returns

Promise\<boolean>

Overrides

DependencyGraphBase.isDependencyForAnyResourceOfCollection

Defined in

src/dependency-graph/mongodb.ts:156

---

isDirectDependency

▸ isDirectDependency(source, target): Promise\<boolean>

Is target a direct dependency for source?

Parameters

Name	Type
source	DependencyGraphResource
target	DependencyGraphResource

Returns

Promise\<boolean>

Overrides

DependencyGraphBase.isDirectDependency

Defined in

src/dependency-graph/mongodb.ts:91

---

populate

▸ populate(): Promise\<void>

Used at Payload initialization to populate the dependency graph. You shouldn't call this function by yourself.

Returns

Promise\<void>

Inherited from

DependencyGraphBase.populate

Defined in

src/dependency-graph/base.ts:151

---

purgeDependentOn

▸ purgeDependentOn(resource): Promise\<void>

The function purges the dependentsOn for a resource and removes for that dependencies the dependencyFor.

Parameters

Name	Type
resource	DependencyGraphResource

Returns

Promise\<void>

Overrides

DependencyGraphBase.purgeDependentOn

Defined in

src/dependency-graph/mongodb.ts:63

---

safeFindOne

▸ safeFindOne(resource): Promise\<WithId\<AnyObject>>

Find a resource and if doesn't exist, it will create it

Parameters

Name	Type
resource	DependencyGraphResource

Returns

Promise\<WithId\<AnyObject>>

Defined in

src/dependency-graph/mongodb.ts:337

---

setEditorExtractor

▸ setEditorExtractor(editorExtractor): DependencyGraphBase

Parameters

Name	Type
editorExtractor	EditorExtractor

Returns

DependencyGraphBase

Inherited from

DependencyGraphBase.setEditorExtractor

Defined in

src/dependency-graph/base.ts:54

---

setPayload

▸ setPayload(payload): DependencyGraphBase

Parameters

Name	Type
payload	Payload

Returns

DependencyGraphBase

Inherited from

DependencyGraphBase.setPayload

Defined in

src/dependency-graph/base.ts:49

---

setSchema

▸ setSchema(schema): DependencyGraphBase

Parameters

Name	Type
schema	DependencyGraphSchema

Returns

DependencyGraphBase

Inherited from

DependencyGraphBase.setSchema

Defined in

src/dependency-graph/base.ts:44

---

compareResources

▸ compareResources(first, second): boolean

Compares two resources with each other

Parameters

Name	Type
first	DependencyGraphResource
second	DependencyGraphResource

Returns

boolean

true if the resources are the same, false otherwise

Inherited from

DependencyGraphBase.compareResources

Defined in

src/dependency-graph/base.ts:18