Class FiefAuth<RQ>

Class implementing common logic for authenticating requests in NodeJS servers.

Type Parameters

RQ

Hierarchy

FiefAuth

Index

Constructors

Properties

client tokenGetter userInfoCache?

Methods

Constructors

constructor

new FiefAuth<RQ>(client, tokenGetter, userInfoCache?): FiefAuth<RQ>
Type Parameters
- RQ
Parameters
- client: Fief
  
  Instance of a Fief client.
- tokenGetter: TokenGetter<RQ>
  
  A TokenGetter function.
- Optional userInfoCache: IUserInfoCache
  
  An instance of a IUserInfoCache class.
Returns FiefAuth<RQ>
- Defined in src/server.ts:138

Properties

`Private` client

client: Fief

`Private` tokenGetter

tokenGetter: TokenGetter<RQ>

`Private` `Optional` userInfoCache

userInfoCache?: IUserInfoCache

Methods

authenticate

authenticate(parameters): ((req) => Promise<AuthenticateRequestResult>)
Factory to generate handler for authenticating NodeJS requests.
Parameters
- parameters: AuthenticateRequestParameters
  
  Parameters to apply when authenticating the request.
Returns ((req) => Promise<AuthenticateRequestResult>)
A handler to authenticate NodeJS requests.
- - (req): Promise<AuthenticateRequestResult>
  - Parameters
    - req: RQ
    Returns Promise<AuthenticateRequestResult>
- Defined in src/server.ts:151

Generated using TypeDoc