File tree Expand file tree Collapse file tree 2 files changed +7
-7
lines changed Expand file tree Collapse file tree 2 files changed +7
-7
lines changed Original file line number Diff line number Diff line change @@ -31,7 +31,7 @@ export class AdminModule implements OnModuleInit {
31
31
) { }
32
32
33
33
/**
34
- * Creates admin in an synchronous way
34
+ * Creates admin in a synchronous way
35
35
*
36
36
* @param {AdminModuleOptions } options
37
37
* @memberof module:@admin-bro/nestjs~AdminModule
@@ -66,7 +66,7 @@ export class AdminModule implements OnModuleInit {
66
66
}
67
67
68
68
/**
69
- * Creates admin in a synchronous way
69
+ * Creates admin in an asynchronous way
70
70
*
71
71
* @param {AdminModuleFactory } options
72
72
* @memberof module:@admin-bro/nestjs~AdminModule
@@ -112,7 +112,7 @@ export class AdminModule implements OnModuleInit {
112
112
}
113
113
114
114
/**
115
- * Initiates the module
115
+ * Applies given options to AdminBro and initializes it
116
116
*/
117
117
public onModuleInit ( ) {
118
118
const admin = new AdminBro ( this . adminModuleOptions . adminBroOptions ) ;
Original file line number Diff line number Diff line change @@ -15,22 +15,22 @@ export type AdminModuleOptions = {
15
15
*/
16
16
adminBroOptions : AdminBroOptions ,
17
17
/**
18
- * Authentication options
18
+ * Authentication options. When NOT provided, it will initialize AdminBro without login page and authorization function.
19
19
*/
20
20
auth ?: {
21
21
/**
22
- * Authenticate method
22
+ * verifies if given credentials are valid, therefore if user has access to Admin Panel
23
23
*/
24
24
authenticate : ( email : string , password : string ) => Promise < CurrentAdmin > ,
25
25
cookiePassword : string ,
26
26
cookieName : string ,
27
27
}
28
28
/**
29
- * Options passed to express formidable (used by AdminBro)
29
+ * Options passed to express formidable (used only by AdminBro express module )
30
30
*/
31
31
formidableOptions ?: ExpressFormidableOptions ,
32
32
/**
33
- * Options passed to express session (used by AdminBro)
33
+ * Options passed to express session (used only by AdminBro express module )
34
34
* Here you might want to change the store from the default memory store to
35
35
* something more reliable (i.e. database).
36
36
*/
You can’t perform that action at this time.
0 commit comments