Function extractUserIdFromRequestHeaders

extractUserIdFromRequestHeaders<UserId extends string | number>(
    headers: HeaderContainer,
    jwtParams: Readonly<ParseJwtParams>,
    cookieName?: string,
    overrides?: PartialWithUndefined<{ csrfHeaderName: string }>,
): Promise<Readonly<UserIdResult<UserId>> | undefined>
Extract the user id from a request by checking both the request cookie and CSRF token. This is used by host (backend) code to help verify a request. After extracting the user id using this, you should compare it to users stored in your database.
Type Parameters
- UserId extends string | number
Parameters
- headers: HeaderContainer
- jwtParams: Readonly<ParseJwtParams>
- cookieName: string = AuthCookieName.Auth
- overrides: PartialWithUndefined<{ csrfHeaderName: string }> = {}
Returns Promise<Readonly<UserIdResult<UserId>> | undefined>
The extracted user id or undefined if no valid auth headers exist.
- Defined in packages/auth-vir/src/auth.ts:77