Skip to content

Commit 8eadbd4

Browse files
RmannnRmannn
committed
Update doc
1 parent 16dff6f commit 8eadbd4

22 files changed

Lines changed: 183 additions & 153 deletions

‎docs/assets/js/search.json‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎docs/classes/_classes_memory_user_.memoryuser.html‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ <h3>_id</h3>
114114
<aside class="tsd-sources">
115115
<p>Overrides <a href="_classes_user_.user.html">User</a>.<a href="_classes_user_.user.html#_id">_id</a></p>
116116
<ul>
117-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/032c3c8/src/classes/memory.user.ts#L4">src/classes/memory.user.ts:4</a></li>
117+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/16dff6f/src/classes/memory.user.ts#L4">src/classes/memory.user.ts:4</a></li>
118118
</ul>
119119
</aside>
120120
</section>
@@ -126,7 +126,7 @@ <h3>email</h3>
126126
<p>Implementation of <a href="../interfaces/_interfaces_emailpassword_.iemailpassword.html">IEmailPassword</a>.<a href="../interfaces/_interfaces_emailpassword_.iemailpassword.html#email">email</a></p>
127127
<p>Inherited from <a href="_classes_user_.user.html">User</a>.<a href="_classes_user_.user.html#email">email</a></p>
128128
<ul>
129-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/032c3c8/src/classes/user.ts#L5">src/classes/user.ts:5</a></li>
129+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/16dff6f/src/classes/user.ts#L5">src/classes/user.ts:5</a></li>
130130
</ul>
131131
</aside>
132132
</section>
@@ -136,7 +136,7 @@ <h3>first<wbr>Name</h3>
136136
<div class="tsd-signature tsd-kind-icon">first<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
137137
<aside class="tsd-sources">
138138
<ul>
139-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/032c3c8/src/classes/memory.user.ts#L5">src/classes/memory.user.ts:5</a></li>
139+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/16dff6f/src/classes/memory.user.ts#L5">src/classes/memory.user.ts:5</a></li>
140140
</ul>
141141
</aside>
142142
</section>
@@ -146,7 +146,7 @@ <h3>last<wbr>Name</h3>
146146
<div class="tsd-signature tsd-kind-icon">last<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
147147
<aside class="tsd-sources">
148148
<ul>
149-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/032c3c8/src/classes/memory.user.ts#L6">src/classes/memory.user.ts:6</a></li>
149+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/16dff6f/src/classes/memory.user.ts#L6">src/classes/memory.user.ts:6</a></li>
150150
</ul>
151151
</aside>
152152
</section>
@@ -157,7 +157,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> namespace</h3>
157157
<aside class="tsd-sources">
158158
<p>Inherited from <a href="_classes_user_.user.html">User</a>.<a href="_classes_user_.user.html#namespace">namespace</a></p>
159159
<ul>
160-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/032c3c8/src/classes/user.ts#L6">src/classes/user.ts:6</a></li>
160+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/16dff6f/src/classes/user.ts#L6">src/classes/user.ts:6</a></li>
161161
</ul>
162162
</aside>
163163
</section>
@@ -169,7 +169,7 @@ <h3>password<wbr>Encrypted</h3>
169169
<p>Implementation of <a href="../interfaces/_interfaces_emailpassword_.iemailpassword.html">IEmailPassword</a>.<a href="../interfaces/_interfaces_emailpassword_.iemailpassword.html#passwordencrypted">passwordEncrypted</a></p>
170170
<p>Inherited from <a href="_classes_user_.user.html">User</a>.<a href="_classes_user_.user.html#passwordencrypted">passwordEncrypted</a></p>
171171
<ul>
172-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/032c3c8/src/classes/user.ts#L7">src/classes/user.ts:7</a></li>
172+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/16dff6f/src/classes/user.ts#L7">src/classes/user.ts:7</a></li>
173173
</ul>
174174
</aside>
175175
</section>
@@ -179,7 +179,7 @@ <h3>roles</h3>
179179
<div class="tsd-signature tsd-kind-icon">roles<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
180180
<aside class="tsd-sources">
181181
<ul>
182-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/032c3c8/src/classes/memory.user.ts#L7">src/classes/memory.user.ts:7</a></li>
182+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/16dff6f/src/classes/memory.user.ts#L7">src/classes/memory.user.ts:7</a></li>
183183
</ul>
184184
</aside>
185185
</section>

‎docs/classes/_classes_user_.user.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ <h3>_id</h3>
110110
<div class="tsd-signature tsd-kind-icon">_id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
111111
<aside class="tsd-sources">
112112
<ul>
113-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/032c3c8/src/classes/user.ts#L4">src/classes/user.ts:4</a></li>
113+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/16dff6f/src/classes/user.ts#L4">src/classes/user.ts:4</a></li>
114114
</ul>
115115
</aside>
116116
</section>
@@ -121,7 +121,7 @@ <h3>email</h3>
121121
<aside class="tsd-sources">
122122
<p>Implementation of <a href="../interfaces/_interfaces_emailpassword_.iemailpassword.html">IEmailPassword</a>.<a href="../interfaces/_interfaces_emailpassword_.iemailpassword.html#email">email</a></p>
123123
<ul>
124-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/032c3c8/src/classes/user.ts#L5">src/classes/user.ts:5</a></li>
124+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/16dff6f/src/classes/user.ts#L5">src/classes/user.ts:5</a></li>
125125
</ul>
126126
</aside>
127127
</section>
@@ -131,7 +131,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> namespace</h3>
131131
<div class="tsd-signature tsd-kind-icon">namespace<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
132132
<aside class="tsd-sources">
133133
<ul>
134-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/032c3c8/src/classes/user.ts#L6">src/classes/user.ts:6</a></li>
134+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/16dff6f/src/classes/user.ts#L6">src/classes/user.ts:6</a></li>
135135
</ul>
136136
</aside>
137137
</section>
@@ -142,7 +142,7 @@ <h3>password<wbr>Encrypted</h3>
142142
<aside class="tsd-sources">
143143
<p>Implementation of <a href="../interfaces/_interfaces_emailpassword_.iemailpassword.html">IEmailPassword</a>.<a href="../interfaces/_interfaces_emailpassword_.iemailpassword.html#passwordencrypted">passwordEncrypted</a></p>
144144
<ul>
145-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/032c3c8/src/classes/user.ts#L7">src/classes/user.ts:7</a></li>
145+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/16dff6f/src/classes/user.ts#L7">src/classes/user.ts:7</a></li>
146146
</ul>
147147
</aside>
148148
</section>

‎docs/classes/_controller_.authcontroller.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ <h3>login<wbr>Action</h3>
121121
<li class="tsd-description">
122122
<aside class="tsd-sources">
123123
<ul>
124-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/032c3c8/src/controller.ts#L18">src/controller.ts:18</a></li>
124+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/16dff6f/src/controller.ts#L18">src/controller.ts:18</a></li>
125125
</ul>
126126
</aside>
127127
<div class="tsd-comment tsd-typography">
@@ -165,7 +165,7 @@ <h3>login<wbr>Check<wbr>Action</h3>
165165
<li class="tsd-description">
166166
<aside class="tsd-sources">
167167
<ul>
168-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/032c3c8/src/controller.ts#L31">src/controller.ts:31</a></li>
168+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/16dff6f/src/controller.ts#L31">src/controller.ts:31</a></li>
169169
</ul>
170170
</aside>
171171
<div class="tsd-comment tsd-typography">
@@ -202,7 +202,7 @@ <h3>logout<wbr>Action</h3>
202202
<li class="tsd-description">
203203
<aside class="tsd-sources">
204204
<ul>
205-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/032c3c8/src/controller.ts#L47">src/controller.ts:47</a></li>
205+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/16dff6f/src/controller.ts#L47">src/controller.ts:47</a></li>
206206
</ul>
207207
</aside>
208208
<div class="tsd-comment tsd-typography">

‎docs/classes/_guard_.authguard.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ <h3>constructor</h3>
119119
<li class="tsd-description">
120120
<aside class="tsd-sources">
121121
<ul>
122-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/032c3c8/src/guard.ts#L12">src/guard.ts:12</a></li>
122+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/16dff6f/src/guard.ts#L12">src/guard.ts:12</a></li>
123123
</ul>
124124
</aside>
125125
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -141,7 +141,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> <span class="tsd-fl
141141
<div class="tsd-signature tsd-kind-icon">options<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_guard_.iauthguardoptions.html" class="tsd-signature-type">IAuthGuardOptions</a></div>
142142
<aside class="tsd-sources">
143143
<ul>
144-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/032c3c8/src/guard.ts#L12">src/guard.ts:12</a></li>
144+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/16dff6f/src/guard.ts#L12">src/guard.ts:12</a></li>
145145
</ul>
146146
</aside>
147147
</section>
@@ -158,7 +158,7 @@ <h3>can<wbr>Activate</h3>
158158
<li class="tsd-description">
159159
<aside class="tsd-sources">
160160
<ul>
161-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/032c3c8/src/guard.ts#L30">src/guard.ts:30</a></li>
161+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/16dff6f/src/guard.ts#L30">src/guard.ts:30</a></li>
162162
</ul>
163163
</aside>
164164
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -181,7 +181,7 @@ <h3>login</h3>
181181
<li class="tsd-description">
182182
<aside class="tsd-sources">
183183
<ul>
184-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/032c3c8/src/guard.ts#L74">src/guard.ts:74</a></li>
184+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/16dff6f/src/guard.ts#L74">src/guard.ts:74</a></li>
185185
</ul>
186186
</aside>
187187
<h4 class="tsd-type-parameters-title">Type parameters</h4>

‎docs/classes/_module_.authmodule.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ <h3>configure</h3>
109109
<li class="tsd-description">
110110
<aside class="tsd-sources">
111111
<ul>
112-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/032c3c8/src/module.ts#L13">src/module.ts:13</a></li>
112+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/16dff6f/src/module.ts#L13">src/module.ts:13</a></li>
113113
</ul>
114114
</aside>
115115
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -132,7 +132,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-
132132
<li class="tsd-description">
133133
<aside class="tsd-sources">
134134
<ul>
135-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/032c3c8/src/module.ts#L19">src/module.ts:19</a></li>
135+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/16dff6f/src/module.ts#L19">src/module.ts:19</a></li>
136136
</ul>
137137
</aside>
138138
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -155,7 +155,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> register</h3>
155155
<li class="tsd-description">
156156
<aside class="tsd-sources">
157157
<ul>
158-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/032c3c8/src/module.ts#L23">src/module.ts:23</a></li>
158+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/16dff6f/src/module.ts#L23">src/module.ts:23</a></li>
159159
</ul>
160160
</aside>
161161
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -178,7 +178,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> register<wbr>Async</h3>
178178
<li class="tsd-description">
179179
<aside class="tsd-sources">
180180
<ul>
181-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/032c3c8/src/module.ts#L41">src/module.ts:41</a></li>
181+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/16dff6f/src/module.ts#L41">src/module.ts:41</a></li>
182182
</ul>
183183
</aside>
184184
<h4 class="tsd-parameters-title">Parameters</h4>

‎docs/classes/_providers_auth_provider_.authuserprovider.html‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ <h3>constructor</h3>
129129
<li class="tsd-description">
130130
<aside class="tsd-sources">
131131
<ul>
132-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/032c3c8/src/providers/auth.provider.ts#L8">src/providers/auth.provider.ts:8</a></li>
132+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/16dff6f/src/providers/auth.provider.ts#L8">src/providers/auth.provider.ts:8</a></li>
133133
</ul>
134134
</aside>
135135
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -157,7 +157,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag t
157157
<div class="tsd-signature tsd-kind-icon">encryptor<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_interfaces_encrypt_.iencrypt.html" class="tsd-signature-type">IEncrypt</a></div>
158158
<aside class="tsd-sources">
159159
<ul>
160-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/032c3c8/src/providers/auth.provider.ts#L12">src/providers/auth.provider.ts:12</a></li>
160+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/16dff6f/src/providers/auth.provider.ts#L12">src/providers/auth.provider.ts:12</a></li>
161161
</ul>
162162
</aside>
163163
</section>
@@ -167,7 +167,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag t
167167
<div class="tsd-signature tsd-kind-icon">provider<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
168168
<aside class="tsd-sources">
169169
<ul>
170-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/032c3c8/src/providers/auth.provider.ts#L10">src/providers/auth.provider.ts:10</a></li>
170+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/16dff6f/src/providers/auth.provider.ts#L10">src/providers/auth.provider.ts:10</a></li>
171171
</ul>
172172
</aside>
173173
</section>
@@ -177,7 +177,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag t
177177
<div class="tsd-signature tsd-kind-icon">user<wbr>Provider<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_interfaces_provider_.iuserprovider.html" class="tsd-signature-type">IUserProvider</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></div>
178178
<aside class="tsd-sources">
179179
<ul>
180-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/032c3c8/src/providers/auth.provider.ts#L11">src/providers/auth.provider.ts:11</a></li>
180+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/16dff6f/src/providers/auth.provider.ts#L11">src/providers/auth.provider.ts:11</a></li>
181181
</ul>
182182
</aside>
183183
</section>
@@ -193,9 +193,8 @@ <h3>get<wbr>Name</h3>
193193
<ul class="tsd-descriptions">
194194
<li class="tsd-description">
195195
<aside class="tsd-sources">
196-
<p>Implementation of <a href="../interfaces/_interfaces_provider_.iauthprovider.html">IAuthProvider</a>.<a href="../interfaces/_interfaces_provider_.iauthprovider.html#getname">getName</a></p>
197196
<ul>
198-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/032c3c8/src/providers/auth.provider.ts#L31">src/providers/auth.provider.ts:31</a></li>
197+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/16dff6f/src/providers/auth.provider.ts#L15">src/providers/auth.provider.ts:15</a></li>
199198
</ul>
200199
</aside>
201200
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
@@ -212,7 +211,7 @@ <h3>load<wbr>User</h3>
212211
<li class="tsd-description">
213212
<aside class="tsd-sources">
214213
<ul>
215-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/032c3c8/src/providers/auth.provider.ts#L15">src/providers/auth.provider.ts:15</a></li>
214+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/16dff6f/src/providers/auth.provider.ts#L19">src/providers/auth.provider.ts:19</a></li>
216215
</ul>
217216
</aside>
218217
<h4 class="tsd-parameters-title">Parameters</h4>

‎docs/classes/_providers_memory_provider_.memoryuserprovider.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag t
117117
<div class="tsd-signature tsd-kind-icon">users<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">U</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = new Map()</span></div>
118118
<aside class="tsd-sources">
119119
<ul>
120-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/032c3c8/src/providers/memory.provider.ts#L8">src/providers/memory.provider.ts:8</a></li>
120+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/16dff6f/src/providers/memory.provider.ts#L8">src/providers/memory.provider.ts:8</a></li>
121121
</ul>
122122
</aside>
123123
</section>
@@ -134,7 +134,7 @@ <h3>find<wbr>One</h3>
134134
<li class="tsd-description">
135135
<aside class="tsd-sources">
136136
<ul>
137-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/032c3c8/src/providers/memory.provider.ts#L10">src/providers/memory.provider.ts:10</a></li>
137+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/16dff6f/src/providers/memory.provider.ts#L10">src/providers/memory.provider.ts:10</a></li>
138138
</ul>
139139
</aside>
140140
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@@ -163,7 +163,7 @@ <h3>register<wbr>User</h3>
163163
<li class="tsd-description">
164164
<aside class="tsd-sources">
165165
<ul>
166-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/032c3c8/src/providers/memory.provider.ts#L22">src/providers/memory.provider.ts:22</a></li>
166+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-authentication/blob/16dff6f/src/providers/memory.provider.ts#L22">src/providers/memory.provider.ts:22</a></li>
167167
</ul>
168168
</aside>
169169
<h4 class="tsd-parameters-title">Parameters</h4>

0 commit comments

Comments
 (0)