auth-vir - v3.1.0
    Preparing search index...

    Function extractUserIdFromRequestHeaders

    • 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>
      • csrfHeaderNameOption: Readonly<
            _RequireExactlyOne<
                { csrfHeaderName: string; csrfHeaderPrefix: string },
                "csrfHeaderPrefix" | "csrfHeaderName",
            >,
        >
      • cookieName: string = AuthCookieName.Auth

      Returns Promise<Readonly<UserIdResult<UserId>> | undefined>

      The extracted user id or undefined if no valid auth headers exist.