Type alias: Authenticator<UserType>
Ƭ Authenticator<UserType>: ({ user }: { authController: AuthController<UserType> ; dataSource: DataSource ; dateTimeFormat?: string ; locale?: Locale ; storageSource: StorageSource ; user: UserType | null }) => boolean | Promise<boolean>
Type parameters
| Name | Type |
|---|---|
UserType | extends User = User |
Type declaration
▸ ({ user }): boolean | Promise<boolean>
Implement this function to allow access to specific users.
You might want to load additional properties for a user asynchronously
and store it using the setExtra method in the authController
Parameters
| Name | Type | Description |
|---|---|---|
{ user } | Object | - |
{ user }.authController | AuthController<UserType> | AuthController |
{ user }.dataSource | DataSource | Connector to your database, e.g. your Firestore database |
{ user }.dateTimeFormat? | string | Format of the dates in the CMS. Defaults to 'MMMM dd, yyyy, HH:mm:ss' |
{ user }.locale? | Locale | Locale of the CMS, currently only affecting dates |
{ user }.storageSource | StorageSource | Used storage implementation |
{ user }.user | UserType | null | Logged in user or null |
Returns
boolean | Promise<boolean>