The 'authorization' property is not available on the 'Request' object

Question

The 'authorization' property is not available on the 'Request' object

Here is a code snippet to consider:

  setContext(async (req, { headers }) => {
    const token = await getToken(config.resources.gatewayApi.scopes)

    const completeHeader = {
      headers: {
        ...headers,
        authorization:
          token && token.accessToken ? `Bearer ${token.accessToken}` : '',
      } as Express.Request,
    }

    console.log('accessToken: ', completeHeader.headers.authorization)
    return completeHeader
  })

An issue arises with the following TS error message:

Property 'authorization' does not exist on type 'Request'.

The error occurs when trying to retrieve

completeHeader.headers.authorization

. This property authorization is not part of the Express.request interface. It seems odd that TypeScript cannot infer the correct type from the literal object, which is clearly a string. Without explicitly setting the type to as Express.Request, an unsafe any assignment error is thrown.

Do we need to create a new TS interface just for this single field? Or are we utilizing an incorrect type definition? The authorization field appears to be commonly used for transmitting tokens.

javascript typescript express

Answer 1

Answer №1

Coercing `completeHeader.headers` into the `Express.Request` type is causing this issue. The coerced type takes precedence over the inferred type.

To resolve this, you can expand the coerced type using the following syntax:

as Express.Request & { authorization: string }

Alternatively, you could define a completely new type like so:

type AuthorizedRequest = Express.Request & { authorization: string };
...
as AuthorizedRequest

Answer 2

Coercing `completeHeader.headers` into the `Express.Request` type is causing this issue. The coerced type takes precedence over the inferred type.

To resolve this, you can expand the coerced type using the following syntax:

as Express.Request & { authorization: string }

Alternatively, you could define a completely new type like so:

type AuthorizedRequest = Express.Request & { authorization: string };
...
as AuthorizedRequest

Answer 3

Answer №2

When I encountered an issue where I needed to add a user but received an error in the headers with authorization(req.headers.authorization), my solution was as follows:

Scenario 1: 1.1. The error pointed to req.headers.authorization, which reminded me of a similar error I had encountered with the user object:

import { IAuthRequest } from "./../types/user.type";

const checkAuth =
    () => async (req: IAuthRequest, res: Response, next: NextFunction) => {
        try {
            //2. The main problem surfaced here
            //To resolve the issue with 'req.user', 
            //I assigned <req:IRequestUser>
            if (!req.headers.authorization) throw new Error("Please log in");

            const token = req.headers.authorization.split(" ")[1];

            if (!process.env.SECRET_ACCESS_TOKEN)
                throw new Error("Please create <SECRET_ACCESS_TOKEN> in .env file");

            const { decoded, expired } = Jwt.verifyJwtToken(
                token,
                process.env.SECRET_ACCESS_TOKEN
            );

            if (expired) return res.status(401).send("Token has been expired");

            //Resolving errors by changing from <req: Request> to <req: IAuthRequest>
            req.user = decoded;

            next();
        } catch (err) {
            return res.status(400).send(err);
        }
    };

1.2. In a folder named "types", I created a file called <user.type.ts> and added:

export interface IUserData {
    _id: string;
    email: string;
    username: string;
}

export interface IRequestUser extends Request {
    user: IUserData;
}

export type IAuthRequest = IRequestUser & {
    headers: { authorization: string };
};

To make the above code work correctly, simply remove the comments for better readability and comprehension.

Scenario 2: Later, I discovered an even simpler solution:

import { IAuthRequest } from "./../types/user.type";

const checkAuth =
    () => async (req: Request, res: Response, next: NextFunction) => {
        try {
            req as IAuthRequest;

            //your code...

            next();
        } catch (err) {
            return res.status(400).send(err);
        }
    };

Hopefully, this can be beneficial to someone facing a similar challenge.

Answer 4

When I encountered an issue where I needed to add a user but received an error in the headers with authorization(req.headers.authorization), my solution was as follows:

Scenario 1: 1.1. The error pointed to req.headers.authorization, which reminded me of a similar error I had encountered with the user object:

import { IAuthRequest } from "./../types/user.type";

const checkAuth =
    () => async (req: IAuthRequest, res: Response, next: NextFunction) => {
        try {
            //2. The main problem surfaced here
            //To resolve the issue with 'req.user', 
            //I assigned <req:IRequestUser>
            if (!req.headers.authorization) throw new Error("Please log in");

            const token = req.headers.authorization.split(" ")[1];

            if (!process.env.SECRET_ACCESS_TOKEN)
                throw new Error("Please create <SECRET_ACCESS_TOKEN> in .env file");

            const { decoded, expired } = Jwt.verifyJwtToken(
                token,
                process.env.SECRET_ACCESS_TOKEN
            );

            if (expired) return res.status(401).send("Token has been expired");

            //Resolving errors by changing from <req: Request> to <req: IAuthRequest>
            req.user = decoded;

            next();
        } catch (err) {
            return res.status(400).send(err);
        }
    };

1.2. In a folder named "types", I created a file called <user.type.ts> and added:

export interface IUserData {
    _id: string;
    email: string;
    username: string;
}

export interface IRequestUser extends Request {
    user: IUserData;
}

export type IAuthRequest = IRequestUser & {
    headers: { authorization: string };
};

To make the above code work correctly, simply remove the comments for better readability and comprehension.

Scenario 2: Later, I discovered an even simpler solution:

import { IAuthRequest } from "./../types/user.type";

const checkAuth =
    () => async (req: Request, res: Response, next: NextFunction) => {
        try {
            req as IAuthRequest;

            //your code...

            next();
        } catch (err) {
            return res.status(400).send(err);
        }
    };

Hopefully, this can be beneficial to someone facing a similar challenge.

Answer 5

Answer №3

const jwt = require('jsonwebtoken');
const { NextFunction, Request } = require('express');
try{
    const authorizationHeader = req.headers.authorization;
    // Here you can add logic to decrypt the token and check for an empty authorization header
}

Simply importing Request from express will allow access to the authorization property on the request headers.

Answer 6

const jwt = require('jsonwebtoken');
const { NextFunction, Request } = require('express');
try{
    const authorizationHeader = req.headers.authorization;
    // Here you can add logic to decrypt the token and check for an empty authorization header
}

Simply importing Request from express will allow access to the authorization property on the request headers.

The 'authorization' property is not available on the 'Request' object

Answer №1

Coercing `completeHeader.headers` into the `Express.Request` type is causing this issue. The coerced type takes precedence over the inferred type.

Answer №2

Answer №3

Similar questions

Can Restify Node return an integer value?

JavaScript library for creating animated car movements on a map using JPG images

Choose multiple children and grandchildren by checking the root checkbox multiple times

Searching for data in MongoDB with multiple conditions using the Mongoose find

Problem with using React state hook

Prepare the column data for Vue Good-Table by formatting it beforehand

JavaScript equivalent code to C#'s File.ReadLines(filepath) would be reading a file line

How can Node.js and Express be used to conceal Javascript code on the backend?

Encountered an issue while working with npm vue-cli

Obtain the values from this JSON array

Retrieving User Keypad Input with Twilio Phone Calling in a Node.js Application (excluding web server)

Exploring IP geolocation integration within Rails 3

Is there a way to prevent a web page from refreshing automatically for a defined duration using programming techniques?

Using JQuery to implement a date and time picker requires setting the default time based on the server's PHP settings

Tips for switching a group of buttons within a userscript by clicking a single button?

Retrieving attribute values when using the .on function in jQuery

Displaying a Countdown in a Django Loop: A Step-by-Step

Storing TypeScript functions as object properties within Angular 6

Discover a multitude of items simultaneously using mongoose

What could be causing the error within the 'react-code-blocks' library?

The 'authorization' property is not available on the 'Request' object

Answer №1

Coercing completeHeader.headers into the Express.Request type is causing this issue. The coerced type takes precedence over the inferred type.

Answer №2

Answer №3

Similar questions

Can Restify Node return an integer value?

JavaScript library for creating animated car movements on a map using JPG images

Choose multiple children and grandchildren by checking the root checkbox multiple times

Searching for data in MongoDB with multiple conditions using the Mongoose find

Problem with using React state hook

Prepare the column data for Vue Good-Table by formatting it beforehand

JavaScript equivalent code to C#'s File.ReadLines(filepath) would be reading a file line

How can Node.js and Express be used to conceal Javascript code on the backend?

Encountered an issue while working with npm vue-cli

Obtain the values from this JSON array

Retrieving User Keypad Input with Twilio Phone Calling in a Node.js Application (excluding web server)

Exploring IP geolocation integration within Rails 3

Is there a way to prevent a web page from refreshing automatically for a defined duration using programming techniques?

Using JQuery to implement a date and time picker requires setting the default time based on the server's PHP settings

Tips for switching a group of buttons within a userscript by clicking a single button?

Retrieving attribute values when using the .on function in jQuery

Displaying a Countdown in a Django Loop: A Step-by-Step

Storing TypeScript functions as object properties within Angular 6

Discover a multitude of items simultaneously using mongoose

What could be causing the error within the 'react-code-blocks' library?

Coercing `completeHeader.headers` into the `Express.Request` type is causing this issue. The coerced type takes precedence over the inferred type.