Abstract Class: BaseAuthBasicRouteMongo

Defined in: src/routes/mongo/BaseAuthBasicRouteMongo.ts:7

Extends

• BaseAuthBasicRoute<UserMongo, SecretMongo, AliasMongo>

Constructors

Constructor

new BaseAuthBasicRouteMongo(): BaseAuthBasicRouteMongo

Returns

BaseAuthBasicRouteMongo

Inherited from

BaseAuthBasicRoute.constructor

Properties

aliasClass

protected aliasClass: any = AliasMongo

Defined in: src/routes/mongo/BaseAuthBasicRouteMongo.ts:8

Overrides

BaseAuthBasicRoute.aliasClass

---

authMiddleware?

protected optional authMiddleware?: AuthMiddleware

Defined in: src/routes/BaseAuthBasicRoute.ts:27

Inherited from

BaseAuthBasicRoute.authMiddleware

---

jwtConfig?

protected optional jwtConfig?: any

Defined in: src/routes/BaseAuthBasicRoute.ts:30

Inherited from

BaseAuthBasicRoute.jwtConfig

---

objectFactory?

protected optional objectFactory?: ObjectFactory

Defined in: src/routes/BaseAuthBasicRoute.ts:33

Inherited from

BaseAuthBasicRoute.objectFactory

---

secretClass

protected secretClass: any = SecretMongo

Defined in: src/routes/mongo/BaseAuthBasicRouteMongo.ts:9

Overrides

BaseAuthBasicRoute.secretClass

---

secretRepo?

protected optional secretRepo?: RepoUtils<SecretMongo>

Defined in: src/routes/BaseAuthBasicRoute.ts:35

Inherited from

BaseAuthBasicRoute.secretRepo

---

userClass

protected userClass: any = UserMongo

Defined in: src/routes/mongo/BaseAuthBasicRouteMongo.ts:10

Overrides

BaseAuthBasicRoute.userClass

---

userUtils?

protected optional userUtils?: UserUtils<UserMongo, AliasMongo>

Defined in: src/routes/BaseAuthBasicRoute.ts:37

Inherited from

BaseAuthBasicRoute.userUtils

Methods

authenticate()

authenticate(user): Promise<AuthResult | undefined>

Defined in: src/routes/BaseAuthBasicRoute.ts:121

Authenticates the user using HTTP Basic and returns a JSON Web Token access token to be used with future API requests.

Parameters

user

JWTUser

Returns

Promise<AuthResult | undefined>

Inherited from

BaseAuthBasicRoute.authenticate

---

initialize()

protected initialize(): Promise<void>

Defined in: src/routes/BaseAuthBasicRoute.ts:43

Called on server startup to initialize the route with any defaults.

Returns

Promise<void>

Inherited from

BaseAuthBasicRoute.initialize