Skip to main content
Version: 2.0.0-alpha

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

NameType
UserTypeextends User = User

Type declaration

▸ ({ user }): boolean | Promise<boolean>

Implement this function to allow access to specific users. You might also want to load additional data for a user asynchronously and store it using the setExtra method in the authController.

Parameters
NameTypeDescription
{ user }Object-
{ user }.authControllerAuthController<UserType>AuthController
{ user }.dataSourceDataSourceConnector to your database, e.g. your Firestore database
{ user }.dateTimeFormat?stringFormat of the dates in the CMS. Defaults to 'MMMM dd, yyyy, HH:mm:ss'
{ user }.locale?LocaleLocale of the CMS, currently only affecting dates
{ user }.storageSourceStorageSourceUsed storage implementation
{ user }.userUserType | nullLogged in user or null
Returns

boolean | Promise<boolean>

Defined in

lib/src/models/user.ts:50