Abstract Class: BaseAuthBasicRoute<U, S, A>

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

Extended by

• BaseAuthBasicRouteMongo
• BaseAuthBasicRouteSQL

Type Parameters

U

U extends User

S

S extends Secret

A

A extends Alias

Constructors

Constructor

new BaseAuthBasicRoute<U, S, A>(): BaseAuthBasicRoute<U, S, A>

Returns

BaseAuthBasicRoute<U, S, A>

Properties

aliasClass

abstract protected aliasClass: any

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

---

authMiddleware?

protected optional authMiddleware?: AuthMiddleware

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

---

defaultScopes

protected defaultScopes: string[] = []

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

---

jwtConfig?

protected optional jwtConfig?: any

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

---

rateLimiter?

protected optional rateLimiter?: RateLimiter

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

---

secretClass

abstract protected secretClass: any

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

---

secretRepo?

protected optional secretRepo?: RepoUtils<S>

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

---

tokenUtils?

protected optional tokenUtils?: TokenUtils

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

---

userClass

abstract protected userClass: any

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

---

userUtils?

protected optional userUtils?: UserUtils<U, A>

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

Methods

authenticate()

authenticate(user, req, res): Promise<AuthResult | undefined>

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

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

Parameters

user

JWTUser

req

HttpRequest

res

HttpResponse

Returns

Promise<AuthResult | undefined>

---

initialize()

protected initialize(): Promise<void>

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

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

Returns

Promise<void>