Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
udamir authored Sep 26, 2021
1 parent 06b4491 commit cd1603c
Showing 1 changed file with 1 addition and 7 deletions.
8 changes: 1 addition & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,39 +75,33 @@ Plugin can be pre-configured with following options:
type AdminRouterOptions = {
/**
* instance of {@link AdminJS}
* @required
*/
admin: AdminJS

/**
* authentication parameters
* @optional
*/
auth?: {
/**
* cookie secret - minimum length of 32 characters
* @required
*/
cookiePassword: string

/**
* cookie name
* @optional
* @default: "adminJS"
*/
cookieName?: string

/**
* secure cookie
* @optional
* @default: false
*/
cookieSecure?: boolean

/**
* authentication check function
* @required
* @returns: user data or null
* @return: user data or null
*/
authenticate: (email: string, password: string) => unknown | null
}
Expand Down

0 comments on commit cd1603c

Please sign in to comment.