-
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathmodules.html
120 lines (117 loc) · 168 KB
/
modules.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>NestJS Mongo - v0.13.2</title><meta name="description" content="Documentation for NestJS Mongo - v0.13.2"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">NestJS Mongo - v0.13.2</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><h1>NestJS Mongo - v0.13.2</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Enumerations</h3><ul class="tsd-index-list"><li class="tsd-kind-enum"><a href="enums/CascadeType.html" class="tsd-kind-icon">Cascade<wbr/>Type</a></li></ul></section><section class="tsd-index-section "><h3>Classes</h3><ul class="tsd-index-list"><li class="tsd-kind-class"><a href="classes/Entity.html" class="tsd-kind-icon">Entity</a></li><li class="tsd-kind-class"><a href="classes/EntityManager.html" class="tsd-kind-icon">Entity<wbr/>Manager</a></li><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/EntityRepository.html" class="tsd-kind-icon">Entity<wbr/>Repository</a></li><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/EntityService.html" class="tsd-kind-icon">Entity<wbr/>Service</a></li><li class="tsd-kind-class"><a href="classes/Filter.html" class="tsd-kind-icon">Filter</a></li><li class="tsd-kind-class"><a href="classes/HistoryAction.html" class="tsd-kind-icon">History<wbr/>Action</a></li><li class="tsd-kind-class"><a href="classes/HistoryActions.html" class="tsd-kind-icon">History<wbr/>Actions</a></li><li class="tsd-kind-class"><a href="classes/IsUniqueConstraint.html" class="tsd-kind-icon">Is<wbr/>Unique<wbr/>Constraint</a></li><li class="tsd-kind-class"><a href="classes/IsValidRelationshipConstraint.html" class="tsd-kind-icon">Is<wbr/>Valid<wbr/>Relationship<wbr/>Constraint</a></li><li class="tsd-kind-class"><a href="classes/MongoModule.html" class="tsd-kind-icon">Mongo<wbr/>Module</a></li><li class="tsd-kind-class"><a href="classes/ObjectIdPipe.html" class="tsd-kind-icon">Object<wbr/>Id<wbr/>Pipe</a></li><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/PaginatedData.html" class="tsd-kind-icon">Paginated<wbr/>Data</a></li><li class="tsd-kind-class"><a href="classes/RelationshipPipe.html" class="tsd-kind-icon">Relationship<wbr/>Pipe</a></li><li class="tsd-kind-class"><a href="classes/RequiredRelationshipPipe.html" class="tsd-kind-icon">Required<wbr/>Relationship<wbr/>Pipe</a></li><li class="tsd-kind-class"><a href="classes/SessionLoaderMiddleware.html" class="tsd-kind-icon">Session<wbr/>Loader<wbr/>Middleware</a></li><li class="tsd-kind-class"><a href="classes/SessionLoaderService.html" class="tsd-kind-icon">Session<wbr/>Loader<wbr/>Service</a></li></ul></section><section class="tsd-index-section "><h3>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface"><a href="interfaces/BaseRelationshipMetadata.html" class="tsd-kind-icon">Base<wbr/>Relationship<wbr/>Metadata</a></li><li class="tsd-kind-interface"><a href="interfaces/ChildRelationshipMetadata.html" class="tsd-kind-icon">Child<wbr/>Relationship<wbr/>Metadata</a></li><li class="tsd-kind-interface"><a href="interfaces/EntityInterface.html" class="tsd-kind-icon">Entity<wbr/>Interface</a></li><li class="tsd-kind-interface"><a href="interfaces/IndexMetadata.html" class="tsd-kind-icon">Index<wbr/>Metadata</a></li><li class="tsd-kind-interface"><a href="interfaces/IsValidRelationshipOptions.html" class="tsd-kind-icon">Is<wbr/>Valid<wbr/>Relationship<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/IsValidRelationshipValidationArguments.html" class="tsd-kind-icon">Is<wbr/>Valid<wbr/>Relationship<wbr/>Validation<wbr/>Arguments</a></li><li class="tsd-kind-interface"><a href="interfaces/MongoFeatureModelOptions.html" class="tsd-kind-icon">Mongo<wbr/>Feature<wbr/>Model<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/MongoFeatureOptions.html" class="tsd-kind-icon">Mongo<wbr/>Feature<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/MongoModuleAsyncOptions.html" class="tsd-kind-icon">Mongo<wbr/>Module<wbr/>Async<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/MongoModuleOptions.html" class="tsd-kind-icon">Mongo<wbr/>Module<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/MongoOptionsFactory.html" class="tsd-kind-icon">Mongo<wbr/>Options<wbr/>Factory</a></li><li class="tsd-kind-interface"><a href="interfaces/PossibleTypes.html" class="tsd-kind-icon">Possible<wbr/>Types</a></li><li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/RelationshipCascade.html" class="tsd-kind-icon">Relationship<wbr/>Cascade</a></li><li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/RelationshipMetadata.html" class="tsd-kind-icon">Relationship<wbr/>Metadata</a></li><li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/RelationshipMetadataOptions.html" class="tsd-kind-icon">Relationship<wbr/>Metadata<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/SerializableInterface.html" class="tsd-kind-icon">Serializable<wbr/>Interface</a></li></ul></section><section class="tsd-index-section "><h3>Type aliases</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#EventCallback" class="tsd-kind-icon">Event<wbr/>Callback</a></li><li class="tsd-kind-type-alias"><a href="modules.html#ExceptionFactory" class="tsd-kind-icon">Exception<wbr/>Factory</a></li><li class="tsd-kind-type-alias"><a href="modules.html#IsUniqueOptions" class="tsd-kind-icon">Is<wbr/>Unique<wbr/>Options</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#RelationshipTypeDescriptor" class="tsd-kind-icon">Relationship<wbr/>Type<wbr/>Descriptor</a></li><li class="tsd-kind-type-alias"><a href="modules.html#WithRelationshipTest" class="tsd-kind-icon">With<wbr/>Relationship<wbr/>Test</a></li><li class="tsd-kind-type-alias"><a href="modules.html#WithValidRelationship" class="tsd-kind-icon">With<wbr/>Valid<wbr/>Relationship</a></li></ul></section><section class="tsd-index-section "><h3>Variables</h3><ul class="tsd-index-list"><li class="tsd-kind-variable"><a href="modules.html#DEBUG" class="tsd-kind-icon">DEBUG</a></li><li class="tsd-kind-variable"><a href="modules.html#DEFAULT_CONNECTION_NAME" class="tsd-kind-icon">DEFAULT_<wbr/>CONNECTION_<wbr/>NAME</a></li><li class="tsd-kind-variable"><a href="modules.html#EXCLUDED_PREFIXES" class="tsd-kind-icon">EXCLUDED_<wbr/>PREFIXES</a></li><li class="tsd-kind-variable"><a href="modules.html#INDEX_METADATA_NAME" class="tsd-kind-icon">INDEX_<wbr/>METADATA_<wbr/>NAME</a></li><li class="tsd-kind-variable"><a href="modules.html#MONGO_SESSION_KEY" class="tsd-kind-icon">MONGO_<wbr/>SESSION_<wbr/>KEY</a></li><li class="tsd-kind-variable"><a href="modules.html#NAMED_CONNECTION_TOKEN" class="tsd-kind-icon">NAMED_<wbr/>CONNECTION_<wbr/>TOKEN</a></li><li class="tsd-kind-variable"><a href="modules.html#RELATIONSHIP_LIST_METADATA_NAME" class="tsd-kind-icon">RELATIONSHIP_<wbr/>LIST_<wbr/>METADATA_<wbr/>NAME</a></li><li class="tsd-kind-variable"><a href="modules.html#RELATIONSHIP_METADATA_NAME" class="tsd-kind-icon">RELATIONSHIP_<wbr/>METADATA_<wbr/>NAME</a></li><li class="tsd-kind-variable"><a href="modules.html#SESSION_LOADER_NAMESPACE" class="tsd-kind-icon">SESSION_<wbr/>LOADER_<wbr/>NAMESPACE</a></li></ul></section><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function"><a href="modules.html#Collection" class="tsd-kind-icon">Collection</a></li><li class="tsd-kind-function"><a href="modules.html#Index" class="tsd-kind-icon">Index</a></li><li class="tsd-kind-function"><a href="modules.html#InjectEntityManager" class="tsd-kind-icon">Inject<wbr/>Entity<wbr/>Manager</a></li><li class="tsd-kind-function"><a href="modules.html#InjectEntityRepository" class="tsd-kind-icon">Inject<wbr/>Entity<wbr/>Repository</a></li><li class="tsd-kind-function"><a href="modules.html#InjectMongoClient" class="tsd-kind-icon">Inject<wbr/>Mongo<wbr/>Client</a></li><li class="tsd-kind-function"><a href="modules.html#IsUnique" class="tsd-kind-icon">Is<wbr/>Unique</a></li><li class="tsd-kind-function"><a href="modules.html#IsValidRelationship" class="tsd-kind-icon">Is<wbr/>Valid<wbr/>Relationship</a></li><li class="tsd-kind-function tsd-has-type-parameter"><a href="modules.html#Relationship" class="tsd-kind-icon">Relationship</a></li><li class="tsd-kind-function"><a href="modules.html#Serializable" class="tsd-kind-icon">Serializable</a></li><li class="tsd-kind-function tsd-has-type-parameter"><a href="modules.html#SlugDecorator" class="tsd-kind-icon">Slug<wbr/>Decorator</a></li><li class="tsd-kind-function tsd-has-type-parameter"><a href="modules.html#Slugify" class="tsd-kind-icon">Slugify</a></li><li class="tsd-kind-function"><a href="modules.html#TypeObjectId" class="tsd-kind-icon">Type<wbr/>Object<wbr/>Id</a></li><li class="tsd-kind-function tsd-has-type-parameter tsd-is-private"><a href="modules.html#addRelationshipMetadata" class="tsd-kind-icon">add<wbr/>Relationship<wbr/>Metadata</a></li><li class="tsd-kind-function tsd-has-type-parameter"><a href="modules.html#ensureSequentialTransaction" class="tsd-kind-icon">ensure<wbr/>Sequential<wbr/>Transaction</a></li><li class="tsd-kind-function tsd-has-type-parameter"><a href="modules.html#fromPlain" class="tsd-kind-icon">from<wbr/>Plain</a></li><li class="tsd-kind-function"><a href="modules.html#getConfigToken" class="tsd-kind-icon">get<wbr/>Config<wbr/>Token</a></li><li class="tsd-kind-function"><a href="modules.html#getConnectionToken" class="tsd-kind-icon">get<wbr/>Connection<wbr/>Token</a></li><li class="tsd-kind-function"><a href="modules.html#getDataloaderToken" class="tsd-kind-icon">get<wbr/>Dataloader<wbr/>Token</a></li><li class="tsd-kind-function"><a href="modules.html#getEntityManagerToken" class="tsd-kind-icon">get<wbr/>Entity<wbr/>Manager<wbr/>Token</a></li><li class="tsd-kind-function"><a href="modules.html#getEntityRepositoryToken" class="tsd-kind-icon">get<wbr/>Entity<wbr/>Repository<wbr/>Token</a></li><li class="tsd-kind-function"><a href="modules.html#getIndexMetadata" class="tsd-kind-icon">get<wbr/>Index<wbr/>Metadata</a></li><li class="tsd-kind-function"><a href="modules.html#getIndexMetadatas" class="tsd-kind-icon">get<wbr/>Index<wbr/>Metadatas</a></li><li class="tsd-kind-function"><a href="modules.html#getObjectName" class="tsd-kind-icon">get<wbr/>Object<wbr/>Name</a></li><li class="tsd-kind-function tsd-has-type-parameter"><a href="modules.html#getRelationshipCascadesMetadata" class="tsd-kind-icon">get<wbr/>Relationship<wbr/>Cascades<wbr/>Metadata</a></li><li class="tsd-kind-function tsd-has-type-parameter"><a href="modules.html#getRelationshipMetadata" class="tsd-kind-icon">get<wbr/>Relationship<wbr/>Metadata</a></li><li class="tsd-kind-function tsd-has-type-parameter"><a href="modules.html#getRelationshipMetadataList" class="tsd-kind-icon">get<wbr/>Relationship<wbr/>Metadata<wbr/>List</a></li><li class="tsd-kind-function tsd-has-type-parameter"><a href="modules.html#getRelationshipsCascadesMetadata" class="tsd-kind-icon">get<wbr/>Relationships<wbr/>Cascades<wbr/>Metadata</a></li><li class="tsd-kind-function"><a href="modules.html#isClass" class="tsd-kind-icon">is<wbr/>Class</a></li><li class="tsd-kind-function tsd-has-type-parameter"><a href="modules.html#merge" class="tsd-kind-icon">merge</a></li><li class="tsd-kind-function"><a href="modules.html#serialize" class="tsd-kind-icon">serialize</a></li><li class="tsd-kind-function"><a href="modules.html#setIndexMetadata" class="tsd-kind-icon">set<wbr/>Index<wbr/>Metadata</a></li><li class="tsd-kind-function tsd-has-type-parameter tsd-is-private"><a href="modules.html#setRelationshipMetadata" class="tsd-kind-icon">set<wbr/>Relationship<wbr/>Metadata</a></li><li class="tsd-kind-function tsd-has-type-parameter"><a href="modules.html#setRelationshipsCascadesMetadata" class="tsd-kind-icon">set<wbr/>Relationships<wbr/>Cascades<wbr/>Metadata</a></li><li class="tsd-kind-function"><a href="modules.html#toJSON" class="tsd-kind-icon">toJSON</a></li><li class="tsd-kind-function tsd-has-type-parameter"><a href="modules.html#toPlain" class="tsd-kind-icon">to<wbr/>Plain</a></li><li class="tsd-kind-function"><a href="modules.html#transformObjectId" class="tsd-kind-icon">transform<wbr/>Object<wbr/>Id</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Type aliases</h2><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter"><a id="EventCallback" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Event<wbr/>Callback<a href="#EventCallback" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Event<wbr/>Callback<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Model</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, change<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ChangeStreamDocument</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Model</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/event/event.ts#L9">src/event/event.ts:9</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>Model<span class="tsd-signature-symbol">: </span><a href="interfaces/EntityInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">EntityInterface</a></h4></li></ul><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, change<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ChangeStreamDocument</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Model</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type">string</span></h5></li><li><h5>change: <span class="tsd-signature-type">ChangeStreamDocument</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Model</span><span class="tsd-signature-symbol">></span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="ExceptionFactory" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Exception<wbr/>Factory<a href="#ExceptionFactory" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Exception<wbr/>Factory<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>errors<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ValidationError</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/module/interfaces.ts#L34">src/module/interfaces.ts:34</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>errors<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ValidationError</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>errors: <span class="tsd-signature-type">ValidationError</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="IsUniqueOptions" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Is<wbr/>Unique<wbr/>Options<a href="#IsUniqueOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Is<wbr/>Unique<wbr/>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ValidationOptions</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>keys<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>noIndex<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>sparse<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/validation/unique/constraint.ts#L13">src/validation/unique/constraint.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter"><a id="RelationshipTypeDescriptor" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Relationship<wbr/>Type<wbr/>Descriptor<a href="#RelationshipTypeDescriptor" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Relationship<wbr/>Type<wbr/>Descriptor<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Relationship</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>obj<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">ClassConstructor</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Relationship</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/relationship/interfaces.ts#L29">src/relationship/interfaces.ts:29</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>Relationship<span class="tsd-signature-symbol">: </span><a href="interfaces/EntityInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">EntityInterface</a></h4></li></ul><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>obj<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ClassConstructor</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Relationship</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
<p>The signature of the function used to determine the type of a relationship target</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> obj: <span class="tsd-signature-type">any</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ClassConstructor</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Relationship</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="WithRelationshipTest" class="tsd-anchor"></a><h3 class="tsd-anchor-link">With<wbr/>Relationship<wbr/>Test<a href="#WithRelationshipTest" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">With<wbr/>Relationship<wbr/>Test<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>object<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, relationship<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, em<span class="tsd-signature-symbol">: </span><a href="classes/EntityManager.html" class="tsd-signature-type" data-tsd-kind="Class">EntityManager</a>, session<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ClientSession</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/relationship/decorators.ts#L20">src/relationship/decorators.ts:20</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>object<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, relationship<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, em<span class="tsd-signature-symbol">: </span><a href="classes/EntityManager.html" class="tsd-signature-type" data-tsd-kind="Class">EntityManager</a>, session<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ClientSession</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>object: <span class="tsd-signature-type">any</span></h5></li><li><h5>relationship: <span class="tsd-signature-type">any</span></h5></li><li><h5>em: <a href="classes/EntityManager.html" class="tsd-signature-type" data-tsd-kind="Class">EntityManager</a></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> session: <span class="tsd-signature-type">ClientSession</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="WithValidRelationship" class="tsd-anchor"></a><h3 class="tsd-anchor-link">With<wbr/>Valid<wbr/>Relationship<a href="#WithValidRelationship" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">With<wbr/>Valid<wbr/>Relationship<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>object<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, relationship<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, em<span class="tsd-signature-symbol">: </span><a href="classes/EntityManager.html" class="tsd-signature-type" data-tsd-kind="Class">EntityManager</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/relationship/decorators.ts#L15">src/relationship/decorators.ts:15</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>object<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, relationship<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, em<span class="tsd-signature-symbol">: </span><a href="classes/EntityManager.html" class="tsd-signature-type" data-tsd-kind="Class">EntityManager</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>object: <span class="tsd-signature-type">any</span></h5></li><li><h5>relationship: <span class="tsd-signature-type">any</span></h5></li><li><h5>em: <a href="classes/EntityManager.html" class="tsd-signature-type" data-tsd-kind="Class">EntityManager</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Variables</h2><section class="tsd-panel tsd-member tsd-kind-variable"><a id="DEBUG" class="tsd-anchor"></a><h3 class="tsd-anchor-link">DEBUG<a href="#DEBUG" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">DEBUG<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"nestjs-mongo"</span><span class="tsd-signature-symbol"> = 'nestjs-mongo'</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/constants.ts#L1">src/constants.ts:1</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-variable"><a id="DEFAULT_CONNECTION_NAME" class="tsd-anchor"></a><h3 class="tsd-anchor-link">DEFAULT_<wbr/>CONNECTION_<wbr/>NAME<a href="#DEFAULT_CONNECTION_NAME" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">DEFAULT_<wbr/>CONNECTION_<wbr/>NAME<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"nestjs-mongo:connection:default"</span><span class="tsd-signature-symbol"> = 'nestjs-mongo:connection:default'</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/constants.ts#L2">src/constants.ts:2</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-variable"><a id="EXCLUDED_PREFIXES" class="tsd-anchor"></a><h3 class="tsd-anchor-link">EXCLUDED_<wbr/>PREFIXES<a href="#EXCLUDED_PREFIXES" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">EXCLUDED_<wbr/>PREFIXES<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/transformer/utils.ts#L6">src/transformer/utils.ts:6</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-variable"><a id="INDEX_METADATA_NAME" class="tsd-anchor"></a><h3 class="tsd-anchor-link">INDEX_<wbr/>METADATA_<wbr/>NAME<a href="#INDEX_METADATA_NAME" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">INDEX_<wbr/>METADATA_<wbr/>NAME<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"nestjs-mongo:index"</span><span class="tsd-signature-symbol"> = 'nestjs-mongo:index'</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/constants.ts#L6">src/constants.ts:6</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-variable"><a id="MONGO_SESSION_KEY" class="tsd-anchor"></a><h3 class="tsd-anchor-link">MONGO_<wbr/>SESSION_<wbr/>KEY<a href="#MONGO_SESSION_KEY" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">MONGO_<wbr/>SESSION_<wbr/>KEY<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ns_sessionloader:mongo_client_session"</span><span class="tsd-signature-symbol"> = 'ns_sessionloader:mongo_client_session'</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/constants.ts#L8">src/constants.ts:8</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-variable"><a id="NAMED_CONNECTION_TOKEN" class="tsd-anchor"></a><h3 class="tsd-anchor-link">NAMED_<wbr/>CONNECTION_<wbr/>TOKEN<a href="#NAMED_CONNECTION_TOKEN" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">NAMED_<wbr/>CONNECTION_<wbr/>TOKEN<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"nestjs-mongo:connection:name"</span><span class="tsd-signature-symbol"> = 'nestjs-mongo:connection:name'</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/constants.ts#L3">src/constants.ts:3</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-variable"><a id="RELATIONSHIP_LIST_METADATA_NAME" class="tsd-anchor"></a><h3 class="tsd-anchor-link">RELATIONSHIP_<wbr/>LIST_<wbr/>METADATA_<wbr/>NAME<a href="#RELATIONSHIP_LIST_METADATA_NAME" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">RELATIONSHIP_<wbr/>LIST_<wbr/>METADATA_<wbr/>NAME<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"nestjs-mongo:relationship_list"</span><span class="tsd-signature-symbol"> = 'nestjs-mongo:relationship_list'</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/constants.ts#L5">src/constants.ts:5</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-variable"><a id="RELATIONSHIP_METADATA_NAME" class="tsd-anchor"></a><h3 class="tsd-anchor-link">RELATIONSHIP_<wbr/>METADATA_<wbr/>NAME<a href="#RELATIONSHIP_METADATA_NAME" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">RELATIONSHIP_<wbr/>METADATA_<wbr/>NAME<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"nestjs-mongo:relationship"</span><span class="tsd-signature-symbol"> = 'nestjs-mongo:relationship'</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/constants.ts#L4">src/constants.ts:4</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-variable"><a id="SESSION_LOADER_NAMESPACE" class="tsd-anchor"></a><h3 class="tsd-anchor-link">SESSION_<wbr/>LOADER_<wbr/>NAMESPACE<a href="#SESSION_LOADER_NAMESPACE" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">SESSION_<wbr/>LOADER_<wbr/>NAMESPACE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"nestjs-mongo:ns_sessionloader"</span><span class="tsd-signature-symbol"> = 'nestjs-mongo:ns_sessionloader'</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/constants.ts#L7">src/constants.ts:7</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Functions</h2><section class="tsd-panel tsd-member tsd-kind-function"><a id="Collection" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Collection<a href="#Collection" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">Collection<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/entity/decorators.ts#L1">src/entity/decorators.ts:1</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>target: <span class="tsd-signature-type">any</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="Index" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Index<a href="#Index" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">Index<span class="tsd-signature-symbol">(</span>metadata<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">IndexDescription</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">CreateIndexesOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, property<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/indexs/decorators.ts#L6">src/indexs/decorators.ts:6</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> metadata: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">IndexDescription</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">CreateIndexesOptions</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, property<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, property<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>target: <span class="tsd-signature-type">any</span></h5></li><li><h5>property: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="InjectEntityManager" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Inject<wbr/>Entity<wbr/>Manager<a href="#InjectEntityManager" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">Inject<wbr/>Entity<wbr/>Manager<span class="tsd-signature-symbol">(</span>connectionName<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/module/injection.ts#L30">src/module/injection.ts:30</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>connectionName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = DEFAULT_CONNECTION_NAME</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
<p>Decorator that marks a constructor parameter as a target for
<a href="https://docs.nestjs.com/providers#dependency-injection">Dependency Injection (DI)</a>.</p>
</div><div><p>Any injected provider must be visible within the module scope (loosely
speaking, the containing module) of the class it is being injected into. This
can be done by:</p>
<ul>
<li>defining the provider in the same module scope</li>
<li>exporting the provider from one module scope and importing that module into the
module scope of the class being injected into</li>
<li>exporting the provider from a module that is marked as global using the
<code>@Global()</code> decorator</li>
</ul>
<a href="#injection-tokens" id="injection-tokens" style="color: inherit; text-decoration: none;">
<h4>Injection tokens</h4>
</a>
<p>Can be <em>types</em> (class names), <em>strings</em> or <em>symbols</em>. This depends on how the
provider with which it is associated was defined. Providers defined with the
<code>@Injectable()</code> decorator use the class name. Custom Providers may use strings
or symbols as the injection token.</p>
</div><dl class="tsd-comment-tags"><dt>see</dt><dd><p><a href="https://docs.nestjs.com/providers">Providers</a></p>
</dd><dt>see</dt><dd><p><a href="https://docs.nestjs.com/fundamentals/custom-providers">Custom Providers</a></p>
</dd><dt>see</dt><dd><p><a href="https://docs.nestjs.com/fundamentals/injection-scopes">Injection Scopes</a></p>
</dd><dt>publicapi</dt><dd></dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>target: <span class="tsd-signature-type">object</span></h5></li><li><h5>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> index: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="InjectEntityRepository" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Inject<wbr/>Entity<wbr/>Repository<a href="#InjectEntityRepository" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">Inject<wbr/>Entity<wbr/>Repository<span class="tsd-signature-symbol">(</span>entity<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ClassConstructor</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span>, connectionName<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/module/injection.ts#L34">src/module/injection.ts:34</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>entity: <span class="tsd-signature-type">ClassConstructor</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5></li><li><h5>connectionName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = DEFAULT_CONNECTION_NAME</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
<p>Decorator that marks a constructor parameter as a target for
<a href="https://docs.nestjs.com/providers#dependency-injection">Dependency Injection (DI)</a>.</p>
</div><div><p>Any injected provider must be visible within the module scope (loosely
speaking, the containing module) of the class it is being injected into. This
can be done by:</p>
<ul>
<li>defining the provider in the same module scope</li>
<li>exporting the provider from one module scope and importing that module into the
module scope of the class being injected into</li>
<li>exporting the provider from a module that is marked as global using the
<code>@Global()</code> decorator</li>
</ul>
<a href="#injection-tokens" id="injection-tokens" style="color: inherit; text-decoration: none;">
<h4>Injection tokens</h4>
</a>
<p>Can be <em>types</em> (class names), <em>strings</em> or <em>symbols</em>. This depends on how the
provider with which it is associated was defined. Providers defined with the
<code>@Injectable()</code> decorator use the class name. Custom Providers may use strings
or symbols as the injection token.</p>
</div><dl class="tsd-comment-tags"><dt>see</dt><dd><p><a href="https://docs.nestjs.com/providers">Providers</a></p>
</dd><dt>see</dt><dd><p><a href="https://docs.nestjs.com/fundamentals/custom-providers">Custom Providers</a></p>
</dd><dt>see</dt><dd><p><a href="https://docs.nestjs.com/fundamentals/injection-scopes">Injection Scopes</a></p>
</dd><dt>publicapi</dt><dd></dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>target: <span class="tsd-signature-type">object</span></h5></li><li><h5>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> index: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="InjectMongoClient" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Inject<wbr/>Mongo<wbr/>Client<a href="#InjectMongoClient" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">Inject<wbr/>Mongo<wbr/>Client<span class="tsd-signature-symbol">(</span>connectionName<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/module/injection.ts#L26">src/module/injection.ts:26</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>connectionName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = DEFAULT_CONNECTION_NAME</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
<p>Decorator that marks a constructor parameter as a target for
<a href="https://docs.nestjs.com/providers#dependency-injection">Dependency Injection (DI)</a>.</p>
</div><div><p>Any injected provider must be visible within the module scope (loosely
speaking, the containing module) of the class it is being injected into. This
can be done by:</p>
<ul>
<li>defining the provider in the same module scope</li>
<li>exporting the provider from one module scope and importing that module into the
module scope of the class being injected into</li>
<li>exporting the provider from a module that is marked as global using the
<code>@Global()</code> decorator</li>
</ul>
<a href="#injection-tokens" id="injection-tokens" style="color: inherit; text-decoration: none;">
<h4>Injection tokens</h4>
</a>
<p>Can be <em>types</em> (class names), <em>strings</em> or <em>symbols</em>. This depends on how the
provider with which it is associated was defined. Providers defined with the
<code>@Injectable()</code> decorator use the class name. Custom Providers may use strings
or symbols as the injection token.</p>
</div><dl class="tsd-comment-tags"><dt>see</dt><dd><p><a href="https://docs.nestjs.com/providers">Providers</a></p>
</dd><dt>see</dt><dd><p><a href="https://docs.nestjs.com/fundamentals/custom-providers">Custom Providers</a></p>
</dd><dt>see</dt><dd><p><a href="https://docs.nestjs.com/fundamentals/injection-scopes">Injection Scopes</a></p>
</dd><dt>publicapi</dt><dd></dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>target: <span class="tsd-signature-type">object</span></h5></li><li><h5>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> index: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="IsUnique" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Is<wbr/>Unique<a href="#IsUnique" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">Is<wbr/>Unique<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="modules.html#IsUniqueOptions" class="tsd-signature-type" data-tsd-kind="Type alias">IsUniqueOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, propertyName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/validation/unique/decorator.ts#L7">src/validation/unique/decorator.ts:7</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="modules.html#IsUniqueOptions" class="tsd-signature-type" data-tsd-kind="Type alias">IsUniqueOptions</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, propertyName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, propertyName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>target: <span class="tsd-signature-type">any</span></h5></li><li><h5>propertyName: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="IsValidRelationship" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Is<wbr/>Valid<wbr/>Relationship<a href="#IsValidRelationship" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">Is<wbr/>Valid<wbr/>Relationship<span class="tsd-signature-symbol">(</span>validationOptions<span class="tsd-signature-symbol">?: </span><a href="interfaces/IsValidRelationshipOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">IsValidRelationshipOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>object<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, propertyName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/relationship/decorators.ts#L31">src/relationship/decorators.ts:31</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> validationOptions: <a href="interfaces/IsValidRelationshipOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">IsValidRelationshipOptions</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span>object<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, propertyName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>object<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, propertyName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>object: <span class="tsd-signature-type">any</span></h5></li><li><h5>propertyName: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-has-type-parameter"><a id="Relationship" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Relationship<a href="#Relationship" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">Relationship<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">R</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/RelationshipMetadataOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RelationshipMetadataOptions</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">R</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><a href="modules.html#RelationshipTypeDescriptor" class="tsd-signature-type" data-tsd-kind="Type alias">RelationshipTypeDescriptor</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">R</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TFunction</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Y</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TFunction</span>, propertyKey<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, descriptor<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">TypedPropertyDescriptor</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Y</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/relationship/decorators.ts#L48">src/relationship/decorators.ts:48</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>R<span class="tsd-signature-symbol">: </span><a href="interfaces/EntityInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">EntityInterface</a> = <span class="tsd-signature-type">any</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="interfaces/RelationshipMetadataOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RelationshipMetadataOptions</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">R</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><a href="modules.html#RelationshipTypeDescriptor" class="tsd-signature-type" data-tsd-kind="Type alias">RelationshipTypeDescriptor</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">R</span><span class="tsd-signature-symbol">></span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TFunction</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Y</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TFunction</span>, propertyKey<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, descriptor<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">TypedPropertyDescriptor</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Y</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TFunction</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Y</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TFunction</span>, propertyKey<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, descriptor<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">TypedPropertyDescriptor</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Y</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
<p>Function that returns a new decorator that applies all decorators provided by param</p>
</div><div><p>Useful to build new decorators (or a decorator factory) encapsulating multiple decorators related with the same feature</p>
</div><dl class="tsd-comment-tags"><dt>publicapi</dt><dd></dd></dl></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>TFunction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Function</span></h4></li><li><h4>Y</h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>target: <span class="tsd-signature-type">object</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TFunction</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> propertyKey: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> descriptor: <span class="tsd-signature-type">TypedPropertyDescriptor</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Y</span><span class="tsd-signature-symbol">></span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="Serializable" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Serializable<a href="#Serializable" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">Serializable<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/serializer/decorators.ts#L6">src/serializer/decorators.ts:6</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Extend a class to be serializable, add 2 methods serialize() and toJSON()</p>
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>target: <span class="tsd-signature-type">any</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-has-type-parameter"><a id="SlugDecorator" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Slug<wbr/>Decorator<a href="#SlugDecorator" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">Slug<wbr/>Decorator<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, config<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ISlugifyOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/transformer/slug.ts#L23">src/transformer/slug.ts:23</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T</h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>target: <span class="tsd-signature-type">any</span></h5></li><li><h5>key: <span class="tsd-signature-type">string</span></h5></li><li><h5>config: <span class="tsd-signature-type">ISlugifyOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-has-type-parameter"><a id="Slugify" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Slugify<a href="#Slugify" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">Slugify<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>config<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ISlugifyOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TFunction</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Y</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TFunction</span>, propertyKey<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, descriptor<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">TypedPropertyDescriptor</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Y</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/transformer/slug.ts#L35">src/transformer/slug.ts:35</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T = <span class="tsd-signature-type">any</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>config: <span class="tsd-signature-type">ISlugifyOptions</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TFunction</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Y</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TFunction</span>, propertyKey<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, descriptor<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">TypedPropertyDescriptor</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Y</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TFunction</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Y</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TFunction</span>, propertyKey<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, descriptor<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">TypedPropertyDescriptor</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Y</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
<p>Function that returns a new decorator that applies all decorators provided by param</p>
</div><div><p>Useful to build new decorators (or a decorator factory) encapsulating multiple decorators related with the same feature</p>
</div><dl class="tsd-comment-tags"><dt>publicapi</dt><dd></dd></dl></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>TFunction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Function</span></h4></li><li><h4>Y</h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>target: <span class="tsd-signature-type">object</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TFunction</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> propertyKey: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> descriptor: <span class="tsd-signature-type">TypedPropertyDescriptor</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Y</span><span class="tsd-signature-symbol">></span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="TypeObjectId" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Type<wbr/>Object<wbr/>Id<a href="#TypeObjectId" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">Type<wbr/>Object<wbr/>Id<span class="tsd-signature-symbol">(</span>isArray<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TFunction</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Y</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TFunction</span>, propertyKey<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, descriptor<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">TypedPropertyDescriptor</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Y</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/transformer/objectId/index.ts#L22">src/transformer/objectId/index.ts:22</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> isArray: <span class="tsd-signature-type">boolean</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TFunction</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Y</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TFunction</span>, propertyKey<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, descriptor<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">TypedPropertyDescriptor</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Y</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TFunction</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Y</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TFunction</span>, propertyKey<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, descriptor<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">TypedPropertyDescriptor</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Y</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
<p>Function that returns a new decorator that applies all decorators provided by param</p>
</div><div><p>Useful to build new decorators (or a decorator factory) encapsulating multiple decorators related with the same feature</p>
</div><dl class="tsd-comment-tags"><dt>publicapi</dt><dd></dd></dl></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>TFunction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Function</span></h4></li><li><h4>Y</h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>target: <span class="tsd-signature-type">object</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TFunction</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> propertyKey: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> descriptor: <span class="tsd-signature-type">TypedPropertyDescriptor</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Y</span><span class="tsd-signature-symbol">></span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-has-type-parameter tsd-is-private"><a id="addRelationshipMetadata" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagPrivate">Private</span> add<wbr/>Relationship<wbr/>Metadata<a href="#addRelationshipMetadata" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function tsd-has-type-parameter tsd-is-private"><li class="tsd-signature tsd-kind-icon">add<wbr/>Relationship<wbr/>Metadata<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">P</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ClassConstructor</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">P</span><span class="tsd-signature-symbol">></span>, property<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, metadata<span class="tsd-signature-symbol">: </span><a href="interfaces/RelationshipMetadataOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RelationshipMetadataOptions</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/relationship/metadata.ts#L104">src/relationship/metadata.ts:104</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>WRTIE DEF</p>
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>P = <span class="tsd-signature-type">any</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>target: <span class="tsd-signature-type">ClassConstructor</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">P</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>A class constructor</p>
</div></div></li><li><h5>property: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The property containing the child</p>
</div></div></li><li><h5>metadata: <a href="interfaces/RelationshipMetadataOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RelationshipMetadataOptions</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-has-type-parameter"><a id="ensureSequentialTransaction" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagConst">Const</span> ensure<wbr/>Sequential<wbr/>Transaction<a href="#ensureSequentialTransaction" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">ensure<wbr/>Sequential<wbr/>Transaction<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">F</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>ctx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ClientSessionContext</span>, jobFn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">F</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">F</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/session/utils.ts#L3">src/session/utils.ts:3</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>F<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>ctx: <span class="tsd-signature-type">ClientSessionContext</span></h5></li><li><h5>jobFn: <span class="tsd-signature-type" data-tsd-kind="Type parameter">F</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">F</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-has-type-parameter"><a id="fromPlain" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagConst">Const</span> from<wbr/>Plain<a href="#fromPlain" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">from<wbr/>Plain<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Model</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>classType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ClassConstructor</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Model</span><span class="tsd-signature-symbol">></span>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ClassTransformOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Model</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/transformer/utils.ts#L10">src/transformer/utils.ts:10</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>Model<span class="tsd-signature-symbol">: </span><a href="interfaces/EntityInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">EntityInterface</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>classType: <span class="tsd-signature-type">ClassConstructor</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Model</span><span class="tsd-signature-symbol">></span></h5></li><li><h5>data: <span class="tsd-signature-type">object</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">ClassTransformOptions</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type" data-tsd-kind="Type parameter">Model</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="getConfigToken" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Config<wbr/>Token<a href="#getConfigToken" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">get<wbr/>Config<wbr/>Token<span class="tsd-signature-symbol">(</span>connectionName<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/module/injection.ts#L14">src/module/injection.ts:14</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>connectionName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = DEFAULT_CONNECTION_NAME</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="getConnectionToken" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Connection<wbr/>Token<a href="#getConnectionToken" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">get<wbr/>Connection<wbr/>Token<span class="tsd-signature-symbol">(</span>connectionName<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/module/injection.ts#L18">src/module/injection.ts:18</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>connectionName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = DEFAULT_CONNECTION_NAME</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="getDataloaderToken" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Dataloader<wbr/>Token<a href="#getDataloaderToken" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">get<wbr/>Dataloader<wbr/>Token<span class="tsd-signature-symbol">(</span>model<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, connectionName<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/module/injection.ts#L10">src/module/injection.ts:10</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>model: <span class="tsd-signature-type">string</span></h5></li><li><h5>connectionName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = DEFAULT_CONNECTION_NAME</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="getEntityManagerToken" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Entity<wbr/>Manager<wbr/>Token<a href="#getEntityManagerToken" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">get<wbr/>Entity<wbr/>Manager<wbr/>Token<span class="tsd-signature-symbol">(</span>connectionName<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/module/injection.ts#L22">src/module/injection.ts:22</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>connectionName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = DEFAULT_CONNECTION_NAME</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="getEntityRepositoryToken" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Entity<wbr/>Repository<wbr/>Token<a href="#getEntityRepositoryToken" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">get<wbr/>Entity<wbr/>Repository<wbr/>Token<span class="tsd-signature-symbol">(</span>model<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, connectionName<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/module/injection.ts#L6">src/module/injection.ts:6</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>model: <span class="tsd-signature-type">string</span></h5></li><li><h5>connectionName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = DEFAULT_CONNECTION_NAME</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="getIndexMetadata" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Index<wbr/>Metadata<a href="#getIndexMetadata" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">get<wbr/>Index<wbr/>Metadata<span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, property<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/IndexMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">IndexMetadata</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/indexs/metadata.ts#L29">src/indexs/metadata.ts:29</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>target: <span class="tsd-signature-type">any</span></h5></li><li><h5>property: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="interfaces/IndexMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">IndexMetadata</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="getIndexMetadatas" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Index<wbr/>Metadatas<a href="#getIndexMetadatas" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">get<wbr/>Index<wbr/>Metadatas<span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/IndexMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">IndexMetadata</a><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/indexs/metadata.ts#L22">src/indexs/metadata.ts:22</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>target: <span class="tsd-signature-type">any</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="interfaces/IndexMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">IndexMetadata</a><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="getObjectName" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Object<wbr/>Name<a href="#getObjectName" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">get<wbr/>Object<wbr/>Name<span class="tsd-signature-symbol">(</span>o<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/helpers.ts#L3">src/helpers.ts:3</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>o: <span class="tsd-signature-type">Object</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-has-type-parameter"><a id="getRelationshipCascadesMetadata" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Relationship<wbr/>Cascades<wbr/>Metadata<a href="#getRelationshipCascadesMetadata" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">get<wbr/>Relationship<wbr/>Cascades<wbr/>Metadata<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Parent</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Child</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>parent<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ClassConstructor</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Parent</span><span class="tsd-signature-symbol">></span>, relationshipType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ClassConstructor</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Child</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/RelationshipCascade.html" class="tsd-signature-type" data-tsd-kind="Interface">RelationshipCascade</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Child</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/relationship/metadata.ts#L198">src/relationship/metadata.ts:198</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>Parent<span class="tsd-signature-symbol">: </span><a href="interfaces/EntityInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">EntityInterface</a> = <span class="tsd-signature-type">any</span></h4></li><li><h4>Child<span class="tsd-signature-symbol">: </span><a href="interfaces/EntityInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">EntityInterface</a> = <span class="tsd-signature-type">any</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>parent: <span class="tsd-signature-type">ClassConstructor</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Parent</span><span class="tsd-signature-symbol">></span></h5></li><li><h5>relationshipType: <span class="tsd-signature-type">ClassConstructor</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Child</span><span class="tsd-signature-symbol">></span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="interfaces/RelationshipCascade.html" class="tsd-signature-type" data-tsd-kind="Interface">RelationshipCascade</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Child</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h4><div></div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-has-type-parameter"><a id="getRelationshipMetadata" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Relationship<wbr/>Metadata<a href="#getRelationshipMetadata" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">get<wbr/>Relationship<wbr/>Metadata<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">R</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Function</span>, property<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, em<span class="tsd-signature-symbol">?: </span><a href="classes/EntityManager.html" class="tsd-signature-type" data-tsd-kind="Class">EntityManager</a>, obj<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/RelationshipMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">RelationshipMetadata</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">R</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/relationship/metadata.ts#L51">src/relationship/metadata.ts:51</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Get relationship metadata</p>
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>R<span class="tsd-signature-symbol">: </span><a href="interfaces/EntityInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">EntityInterface</a> = <span class="tsd-signature-type">any</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>target: <span class="tsd-signature-type">Function</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>A class constructor</p>
</div></div></li><li><h5>property: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The property that was set as relationship</p>
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> em: <a href="classes/EntityManager.html" class="tsd-signature-type" data-tsd-kind="Class">EntityManager</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The entity manager (only required if the relationship target type is set as a string)</p>
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> obj: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The instance of the entity (only required if the type of the relationship is dynamic)</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="interfaces/RelationshipMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">RelationshipMetadata</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">R</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-has-type-parameter"><a id="getRelationshipMetadataList" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Relationship<wbr/>Metadata<wbr/>List<a href="#getRelationshipMetadataList" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">get<wbr/>Relationship<wbr/>Metadata<wbr/>List<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">P</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ClassConstructor</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">P</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/ChildRelationshipMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">ChildRelationshipMetadata</a><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/relationship/metadata.ts#L126">src/relationship/metadata.ts:126</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>P = <span class="tsd-signature-type">any</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>target: <span class="tsd-signature-type">ClassConstructor</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">P</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The class constructor of an entity</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="interfaces/ChildRelationshipMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">ChildRelationshipMetadata</a><span class="tsd-signature-symbol">[]</span></h4><div></div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-has-type-parameter"><a id="getRelationshipsCascadesMetadata" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Relationships<wbr/>Cascades<wbr/>Metadata<a href="#getRelationshipsCascadesMetadata" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">get<wbr/>Relationships<wbr/>Cascades<wbr/>Metadata<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Parent</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ClassConstructor</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Parent</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/RelationshipCascade.html" class="tsd-signature-type" data-tsd-kind="Interface">RelationshipCascade</a><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/relationship/metadata.ts#L186">src/relationship/metadata.ts:186</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>Parent<span class="tsd-signature-symbol">: </span><a href="interfaces/EntityInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">EntityInterface</a> = <span class="tsd-signature-type">any</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>target: <span class="tsd-signature-type">ClassConstructor</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Parent</span><span class="tsd-signature-symbol">></span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="interfaces/RelationshipCascade.html" class="tsd-signature-type" data-tsd-kind="Interface">RelationshipCascade</a><span class="tsd-signature-symbol">[]</span></h4><div></div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="isClass" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagConst">Const</span> is<wbr/>Class<a href="#isClass" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">is<wbr/>Class<span class="tsd-signature-symbol">(</span>fn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/helpers.ts#L1">src/helpers.ts:1</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>fn: <span class="tsd-signature-type">any</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-has-type-parameter"><a id="merge" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagConst">Const</span> merge<a href="#merge" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">merge<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Model</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>entity<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Model</span>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Model</span>, excludePrefixes<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Model</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/transformer/utils.ts#L25">src/transformer/utils.ts:25</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>Model<span class="tsd-signature-symbol">: </span><a href="interfaces/EntityInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">EntityInterface</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>entity: <span class="tsd-signature-type" data-tsd-kind="Type parameter">Model</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The model to hydrate</p>
</div></div></li><li><h5>data: <span class="tsd-signature-type" data-tsd-kind="Type parameter">Model</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The data to merge into the entity</p>
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> excludePrefixes: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The prefixes to excludes (if the source contains key ith prefix)</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type" data-tsd-kind="Type parameter">Model</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="serialize" class="tsd-anchor"></a><h3 class="tsd-anchor-link">serialize<a href="#serialize" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">serialize<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/serializer/serializer.ts#L3">src/serializer/serializer.ts:3</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="setIndexMetadata" class="tsd-anchor"></a><h3 class="tsd-anchor-link">set<wbr/>Index<wbr/>Metadata<a href="#setIndexMetadata" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">set<wbr/>Index<wbr/>Metadata<span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, metadata<span class="tsd-signature-symbol">: </span><a href="interfaces/IndexMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">IndexMetadata</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/indexs/metadata.ts#L11">src/indexs/metadata.ts:11</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>target: <span class="tsd-signature-type">any</span></h5></li><li><h5>metadata: <a href="interfaces/IndexMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">IndexMetadata</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-has-type-parameter tsd-is-private"><a id="setRelationshipMetadata" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagPrivate">Private</span> set<wbr/>Relationship<wbr/>Metadata<a href="#setRelationshipMetadata" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function tsd-has-type-parameter tsd-is-private"><li class="tsd-signature tsd-kind-icon">set<wbr/>Relationship<wbr/>Metadata<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">R</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, property<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, metadata<span class="tsd-signature-symbol">: </span><a href="interfaces/RelationshipMetadataOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RelationshipMetadataOptions</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">R</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/relationship/metadata.ts#L24">src/relationship/metadata.ts:24</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Set relationship metadata</p>
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>R<span class="tsd-signature-symbol">: </span><a href="interfaces/EntityInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">EntityInterface</a> = <span class="tsd-signature-type">any</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>target: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>An instance of an object</p>
</div></div></li><li><h5>property: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The property to set as relationship</p>
</div></div></li><li><h5>metadata: <a href="interfaces/RelationshipMetadataOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RelationshipMetadataOptions</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">R</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The metadata defining the relationship</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-has-type-parameter"><a id="setRelationshipsCascadesMetadata" class="tsd-anchor"></a><h3 class="tsd-anchor-link">set<wbr/>Relationships<wbr/>Cascades<wbr/>Metadata<a href="#setRelationshipsCascadesMetadata" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">set<wbr/>Relationships<wbr/>Cascades<wbr/>Metadata<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Child</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>ChildClass<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ClassConstructor</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Child</span><span class="tsd-signature-symbol">></span>, manager<span class="tsd-signature-symbol">: </span><a href="classes/EntityManager.html" class="tsd-signature-type" data-tsd-kind="Class">EntityManager</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/relationship/metadata.ts#L135">src/relationship/metadata.ts:135</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>Child<span class="tsd-signature-symbol">: </span><a href="interfaces/EntityInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">EntityInterface</a> = <span class="tsd-signature-type">any</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>ChildClass: <span class="tsd-signature-type">ClassConstructor</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Child</span><span class="tsd-signature-symbol">></span></h5></li><li><h5>manager: <a href="classes/EntityManager.html" class="tsd-signature-type" data-tsd-kind="Class">EntityManager</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link">toJSON<a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">toJSON<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/serializer/serializer.ts#L7">src/serializer/serializer.ts:7</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{}</span></h4><ul class="tsd-parameters"></ul></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-has-type-parameter"><a id="toPlain" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagConst">Const</span> to<wbr/>Plain<a href="#toPlain" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">to<wbr/>Plain<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/transformer/utils.ts#L8">src/transformer/utils.ts:8</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T = <span class="tsd-signature-type">any</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>data: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="transformObjectId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagConst">Const</span> transform<wbr/>Object<wbr/>Id<a href="#transformObjectId" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">transform<wbr/>Object<wbr/>Id<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TransformationType</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ObjectId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ObjectId</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/fbc9bcb/src/transformer/objectId/index.ts#L8">src/transformer/objectId/index.ts:8</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <span class="tsd-signature-type">TransformationType</span></h5></li><li><h5>value: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ObjectId</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ObjectId</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-enum"><a href="enums/CascadeType.html" class="tsd-kind-icon">Cascade<wbr/>Type</a></li><li class="tsd-kind-class"><a href="classes/Entity.html" class="tsd-kind-icon">Entity</a></li><li class="tsd-kind-class"><a href="classes/EntityManager.html" class="tsd-kind-icon">Entity<wbr/>Manager</a></li><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/EntityRepository.html" class="tsd-kind-icon">Entity<wbr/>Repository</a></li><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/EntityService.html" class="tsd-kind-icon">Entity<wbr/>Service</a></li><li class="tsd-kind-class"><a href="classes/Filter.html" class="tsd-kind-icon">Filter</a></li><li class="tsd-kind-class"><a href="classes/HistoryAction.html" class="tsd-kind-icon">History<wbr/>Action</a></li><li class="tsd-kind-class"><a href="classes/HistoryActions.html" class="tsd-kind-icon">History<wbr/>Actions</a></li><li class="tsd-kind-class"><a href="classes/IsUniqueConstraint.html" class="tsd-kind-icon">Is<wbr/>Unique<wbr/>Constraint</a></li><li class="tsd-kind-class"><a href="classes/IsValidRelationshipConstraint.html" class="tsd-kind-icon">Is<wbr/>Valid<wbr/>Relationship<wbr/>Constraint</a></li><li class="tsd-kind-class"><a href="classes/MongoModule.html" class="tsd-kind-icon">Mongo<wbr/>Module</a></li><li class="tsd-kind-class"><a href="classes/ObjectIdPipe.html" class="tsd-kind-icon">Object<wbr/>Id<wbr/>Pipe</a></li><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/PaginatedData.html" class="tsd-kind-icon">Paginated<wbr/>Data</a></li><li class="tsd-kind-class"><a href="classes/RelationshipPipe.html" class="tsd-kind-icon">Relationship<wbr/>Pipe</a></li><li class="tsd-kind-class"><a href="classes/RequiredRelationshipPipe.html" class="tsd-kind-icon">Required<wbr/>Relationship<wbr/>Pipe</a></li><li class="tsd-kind-class"><a href="classes/SessionLoaderMiddleware.html" class="tsd-kind-icon">Session<wbr/>Loader<wbr/>Middleware</a></li><li class="tsd-kind-class"><a href="classes/SessionLoaderService.html" class="tsd-kind-icon">Session<wbr/>Loader<wbr/>Service</a></li><li class="tsd-kind-interface"><a href="interfaces/BaseRelationshipMetadata.html" class="tsd-kind-icon">Base<wbr/>Relationship<wbr/>Metadata</a></li><li class="tsd-kind-interface"><a href="interfaces/ChildRelationshipMetadata.html" class="tsd-kind-icon">Child<wbr/>Relationship<wbr/>Metadata</a></li><li class="tsd-kind-interface"><a href="interfaces/EntityInterface.html" class="tsd-kind-icon">Entity<wbr/>Interface</a></li><li class="tsd-kind-interface"><a href="interfaces/IndexMetadata.html" class="tsd-kind-icon">Index<wbr/>Metadata</a></li><li class="tsd-kind-interface"><a href="interfaces/IsValidRelationshipOptions.html" class="tsd-kind-icon">Is<wbr/>Valid<wbr/>Relationship<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/IsValidRelationshipValidationArguments.html" class="tsd-kind-icon">Is<wbr/>Valid<wbr/>Relationship<wbr/>Validation<wbr/>Arguments</a></li><li class="tsd-kind-interface"><a href="interfaces/MongoFeatureModelOptions.html" class="tsd-kind-icon">Mongo<wbr/>Feature<wbr/>Model<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/MongoFeatureOptions.html" class="tsd-kind-icon">Mongo<wbr/>Feature<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/MongoModuleAsyncOptions.html" class="tsd-kind-icon">Mongo<wbr/>Module<wbr/>Async<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/MongoModuleOptions.html" class="tsd-kind-icon">Mongo<wbr/>Module<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/MongoOptionsFactory.html" class="tsd-kind-icon">Mongo<wbr/>Options<wbr/>Factory</a></li><li class="tsd-kind-interface"><a href="interfaces/PossibleTypes.html" class="tsd-kind-icon">Possible<wbr/>Types</a></li><li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/RelationshipCascade.html" class="tsd-kind-icon">Relationship<wbr/>Cascade</a></li><li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/RelationshipMetadata.html" class="tsd-kind-icon">Relationship<wbr/>Metadata</a></li><li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/RelationshipMetadataOptions.html" class="tsd-kind-icon">Relationship<wbr/>Metadata<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/SerializableInterface.html" class="tsd-kind-icon">Serializable<wbr/>Interface</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#EventCallback" class="tsd-kind-icon">Event<wbr/>Callback</a></li><li class="tsd-kind-type-alias"><a href="modules.html#ExceptionFactory" class="tsd-kind-icon">Exception<wbr/>Factory</a></li><li class="tsd-kind-type-alias"><a href="modules.html#IsUniqueOptions" class="tsd-kind-icon">Is<wbr/>Unique<wbr/>Options</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#RelationshipTypeDescriptor" class="tsd-kind-icon">Relationship<wbr/>Type<wbr/>Descriptor</a></li><li class="tsd-kind-type-alias"><a href="modules.html#WithRelationshipTest" class="tsd-kind-icon">With<wbr/>Relationship<wbr/>Test</a></li><li class="tsd-kind-type-alias"><a href="modules.html#WithValidRelationship" class="tsd-kind-icon">With<wbr/>Valid<wbr/>Relationship</a></li><li class="tsd-kind-variable"><a href="modules.html#DEBUG" class="tsd-kind-icon">DEBUG</a></li><li class="tsd-kind-variable"><a href="modules.html#DEFAULT_CONNECTION_NAME" class="tsd-kind-icon">DEFAULT_<wbr/>CONNECTION_<wbr/>NAME</a></li><li class="tsd-kind-variable"><a href="modules.html#EXCLUDED_PREFIXES" class="tsd-kind-icon">EXCLUDED_<wbr/>PREFIXES</a></li><li class="tsd-kind-variable"><a href="modules.html#INDEX_METADATA_NAME" class="tsd-kind-icon">INDEX_<wbr/>METADATA_<wbr/>NAME</a></li><li class="tsd-kind-variable"><a href="modules.html#MONGO_SESSION_KEY" class="tsd-kind-icon">MONGO_<wbr/>SESSION_<wbr/>KEY</a></li><li class="tsd-kind-variable"><a href="modules.html#NAMED_CONNECTION_TOKEN" class="tsd-kind-icon">NAMED_<wbr/>CONNECTION_<wbr/>TOKEN</a></li><li class="tsd-kind-variable"><a href="modules.html#RELATIONSHIP_LIST_METADATA_NAME" class="tsd-kind-icon">RELATIONSHIP_<wbr/>LIST_<wbr/>METADATA_<wbr/>NAME</a></li><li class="tsd-kind-variable"><a href="modules.html#RELATIONSHIP_METADATA_NAME" class="tsd-kind-icon">RELATIONSHIP_<wbr/>METADATA_<wbr/>NAME</a></li><li class="tsd-kind-variable"><a href="modules.html#SESSION_LOADER_NAMESPACE" class="tsd-kind-icon">SESSION_<wbr/>LOADER_<wbr/>NAMESPACE</a></li><li class="tsd-kind-function"><a href="modules.html#Collection" class="tsd-kind-icon">Collection</a></li><li class="tsd-kind-function"><a href="modules.html#Index" class="tsd-kind-icon">Index</a></li><li class="tsd-kind-function"><a href="modules.html#InjectEntityManager" class="tsd-kind-icon">Inject<wbr/>Entity<wbr/>Manager</a></li><li class="tsd-kind-function"><a href="modules.html#InjectEntityRepository" class="tsd-kind-icon">Inject<wbr/>Entity<wbr/>Repository</a></li><li class="tsd-kind-function"><a href="modules.html#InjectMongoClient" class="tsd-kind-icon">Inject<wbr/>Mongo<wbr/>Client</a></li><li class="tsd-kind-function"><a href="modules.html#IsUnique" class="tsd-kind-icon">Is<wbr/>Unique</a></li><li class="tsd-kind-function"><a href="modules.html#IsValidRelationship" class="tsd-kind-icon">Is<wbr/>Valid<wbr/>Relationship</a></li><li class="tsd-kind-function tsd-has-type-parameter"><a href="modules.html#Relationship" class="tsd-kind-icon">Relationship</a></li><li class="tsd-kind-function"><a href="modules.html#Serializable" class="tsd-kind-icon">Serializable</a></li><li class="tsd-kind-function tsd-has-type-parameter"><a href="modules.html#SlugDecorator" class="tsd-kind-icon">Slug<wbr/>Decorator</a></li><li class="tsd-kind-function tsd-has-type-parameter"><a href="modules.html#Slugify" class="tsd-kind-icon">Slugify</a></li><li class="tsd-kind-function"><a href="modules.html#TypeObjectId" class="tsd-kind-icon">Type<wbr/>Object<wbr/>Id</a></li><li class="tsd-kind-function tsd-has-type-parameter tsd-is-private"><a href="modules.html#addRelationshipMetadata" class="tsd-kind-icon">add<wbr/>Relationship<wbr/>Metadata</a></li><li class="tsd-kind-function tsd-has-type-parameter"><a href="modules.html#ensureSequentialTransaction" class="tsd-kind-icon">ensure<wbr/>Sequential<wbr/>Transaction</a></li><li class="tsd-kind-function tsd-has-type-parameter"><a href="modules.html#fromPlain" class="tsd-kind-icon">from<wbr/>Plain</a></li><li class="tsd-kind-function"><a href="modules.html#getConfigToken" class="tsd-kind-icon">get<wbr/>Config<wbr/>Token</a></li><li class="tsd-kind-function"><a href="modules.html#getConnectionToken" class="tsd-kind-icon">get<wbr/>Connection<wbr/>Token</a></li><li class="tsd-kind-function"><a href="modules.html#getDataloaderToken" class="tsd-kind-icon">get<wbr/>Dataloader<wbr/>Token</a></li><li class="tsd-kind-function"><a href="modules.html#getEntityManagerToken" class="tsd-kind-icon">get<wbr/>Entity<wbr/>Manager<wbr/>Token</a></li><li class="tsd-kind-function"><a href="modules.html#getEntityRepositoryToken" class="tsd-kind-icon">get<wbr/>Entity<wbr/>Repository<wbr/>Token</a></li><li class="tsd-kind-function"><a href="modules.html#getIndexMetadata" class="tsd-kind-icon">get<wbr/>Index<wbr/>Metadata</a></li><li class="tsd-kind-function"><a href="modules.html#getIndexMetadatas" class="tsd-kind-icon">get<wbr/>Index<wbr/>Metadatas</a></li><li class="tsd-kind-function"><a href="modules.html#getObjectName" class="tsd-kind-icon">get<wbr/>Object<wbr/>Name</a></li><li class="tsd-kind-function tsd-has-type-parameter"><a href="modules.html#getRelationshipCascadesMetadata" class="tsd-kind-icon">get<wbr/>Relationship<wbr/>Cascades<wbr/>Metadata</a></li><li class="tsd-kind-function tsd-has-type-parameter"><a href="modules.html#getRelationshipMetadata" class="tsd-kind-icon">get<wbr/>Relationship<wbr/>Metadata</a></li><li class="tsd-kind-function tsd-has-type-parameter"><a href="modules.html#getRelationshipMetadataList" class="tsd-kind-icon">get<wbr/>Relationship<wbr/>Metadata<wbr/>List</a></li><li class="tsd-kind-function tsd-has-type-parameter"><a href="modules.html#getRelationshipsCascadesMetadata" class="tsd-kind-icon">get<wbr/>Relationships<wbr/>Cascades<wbr/>Metadata</a></li><li class="tsd-kind-function"><a href="modules.html#isClass" class="tsd-kind-icon">is<wbr/>Class</a></li><li class="tsd-kind-function tsd-has-type-parameter"><a href="modules.html#merge" class="tsd-kind-icon">merge</a></li><li class="tsd-kind-function"><a href="modules.html#serialize" class="tsd-kind-icon">serialize</a></li><li class="tsd-kind-function"><a href="modules.html#setIndexMetadata" class="tsd-kind-icon">set<wbr/>Index<wbr/>Metadata</a></li><li class="tsd-kind-function tsd-has-type-parameter tsd-is-private"><a href="modules.html#setRelationshipMetadata" class="tsd-kind-icon">set<wbr/>Relationship<wbr/>Metadata</a></li><li class="tsd-kind-function tsd-has-type-parameter"><a href="modules.html#setRelationshipsCascadesMetadata" class="tsd-kind-icon">set<wbr/>Relationships<wbr/>Cascades<wbr/>Metadata</a></li><li class="tsd-kind-function"><a href="modules.html#toJSON" class="tsd-kind-icon">toJSON</a></li><li class="tsd-kind-function tsd-has-type-parameter"><a href="modules.html#toPlain" class="tsd-kind-icon">to<wbr/>Plain</a></li><li class="tsd-kind-function"><a href="modules.html#transformObjectId" class="tsd-kind-icon">transform<wbr/>Object<wbr/>Id</a></li></ul></nav></div></div></div><footer class=""><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="overlay"></div><script src="assets/main.js"></script></body></html>