Skip to content

Commit 56e5e42

Browse files
authored
Adding more description for some methods & fixing typos
1 parent f8c4349 commit 56e5e42

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

src/admin.module.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ export class AdminModule implements OnModuleInit {
3131
) {}
3232

3333
/**
34-
* Creates admin in an synchronous way
34+
* Creates admin in a synchronous way
3535
*
3636
* @param {AdminModuleOptions} options
3737
* @memberof module:@admin-bro/nestjs~AdminModule
@@ -66,7 +66,7 @@ export class AdminModule implements OnModuleInit {
6666
}
6767

6868
/**
69-
* Creates admin in a synchronous way
69+
* Creates admin in an asynchronous way
7070
*
7171
* @param {AdminModuleFactory} options
7272
* @memberof module:@admin-bro/nestjs~AdminModule
@@ -112,7 +112,7 @@ export class AdminModule implements OnModuleInit {
112112
}
113113

114114
/**
115-
* Initiates the module
115+
* Applies given options to AdminBro and initializes it
116116
*/
117117
public onModuleInit() {
118118
const admin = new AdminBro(this.adminModuleOptions.adminBroOptions);

src/interfaces/admin-module-options.interface.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,22 +15,22 @@ export type AdminModuleOptions = {
1515
*/
1616
adminBroOptions: AdminBroOptions,
1717
/**
18-
* Authentication options
18+
* Authentication options. When NOT provided, it will initialize AdminBro without login page and authorization function.
1919
*/
2020
auth?: {
2121
/**
22-
* Authenticate method
22+
* verifies if given credentials are valid, therefore if user has access to Admin Panel
2323
*/
2424
authenticate: (email: string, password: string) => Promise<CurrentAdmin>,
2525
cookiePassword: string,
2626
cookieName: string,
2727
}
2828
/**
29-
* Options passed to express formidable (used by AdminBro)
29+
* Options passed to express formidable (used only by AdminBro express module)
3030
*/
3131
formidableOptions?: ExpressFormidableOptions,
3232
/**
33-
* Options passed to express session (used by AdminBro)
33+
* Options passed to express session (used only by AdminBro express module)
3434
* Here you might want to change the store from the default memory store to
3535
* something more reliable (i.e. database).
3636
*/

0 commit comments

Comments
 (0)