Расширение объекта экспресс-запроса с помощью Typescript

Я пытаюсь добавить свойство для выражения объекта запроса из промежуточного программного обеспечения с использованием машинописного текста. Однако я не могу понять, как добавить к объекту дополнительные свойства. Я бы предпочел не использовать скобки, если это возможно.

Я ищу решение, которое позволило бы мне написать что-то подобное (если возможно):

app.use((req, res, next) => {
    req.property = setProperty(); 
    next();
});

Вы хотите создать собственное определение и использовать в Typescript функцию слияния деклараций . Это обычно используется, например, в method-override.

Создайте файл custom.d.tsи убедитесь , чтобы включить его в tsconfig.json«s files-сече- , если таковые имеются. Содержимое может выглядеть следующим образом:

declare namespace Express {
   export interface Request {
      tenant?: string
   }
}

Это позволит вам в любой момент кода использовать что-то вроде этого:

router.use((req, res, next) => {
    req.tenant = 'tenant-X'
    next()
})

router.get('/whichTenant', (req, res) => {
    res.status(200).send('This is your tenant: '+req.tenant)
})

Как указано в комментариях вindex.d.ts , вы просто объявляете в глобальном Expressпространстве имен любые новые члены. Пример:

declare global {
  namespace Express {
    interface Request {
      context: Context
    }
  }
}

Полный пример:

import * as express from 'express';

export class Context {
  constructor(public someContextVariable) {
  }

  log(message: string) {
    console.log(this.someContextVariable, { message });
  }
}

declare global {
  namespace Express {
    interface Request {
      context: Context
    }
  }
}

const app = express();

app.use((req, res, next) => {
  req.context = new Context(req.url);
  next();
});

app.use((req, res, next) => {
  req.context.log('about to return')
  res.send('hello world world');
});

app.listen(3000, () => console.log('Example app listening on port 3000!'))

Более подробно о расширении глобальных пространств имен можно прочитать в моем GitBook .

Для более новых версий Express вам необходимо расширить express-serve-static-coreмодуль.

Это необходимо, потому что теперь объект Express исходит оттуда: https://github.com/DefinitiTyped/DefinitiTyped/blob/8fb0e959c2c7529b5fa4793a44b41b797ae671b9/types/express/index.d.ts#L19

В основном используйте следующее:

declare module 'express-serve-static-core' {
  interface Request {
    myField?: string
  }
  interface Response {
    myField?: string
  }
}

Принятый ответ (как и другие) не работает для меня, но

declare module 'express' {
    interface Request {
        myProperty: string;
    }
}

сделал. Надеюсь, это кому-то поможет.

После того, как попробовали 8 или около того ответов, но безуспешно. Я , наконец , удалось получить его работу с jd291 комментарием указывающей «ы к 3mards репо .

Создайте в базе файл под названием types/express/index.d.ts. И в нем напишите:

declare namespace Express {
    interface Request {
        yourProperty: <YourType>;
    }
}

и включить его в tsconfig.json:

{
    "compilerOptions": {
        "typeRoots": ["./types"]
    }
}

Затем yourPropertyдолжны быть доступны по каждому запросу:

import express from 'express';

const app = express();

app.get('*', (req, res) => {
    req.yourProperty = 
});

Ни одно из предложенных решений у меня не помогло. В итоге я просто расширил интерфейс запроса:

import {Request} from 'express';

export interface RequestCustom extends Request
{
    property: string;
}

Затем использовать:

import {NextFunction, Response} from 'express';
import {RequestCustom} from 'RequestCustom';

someMiddleware(req: RequestCustom, res: Response, next: NextFunction): void
{
    req.property = '';
}

Изменить : последние версии TypeScript жалуются на это. Вместо этого мне пришлось сделать:

someMiddleware(expressRequest: Request, res: Response, next: NextFunction): void
{
    const req = expressRequest as RequestCustom;
    req.property = '';
}

В TypeScript интерфейсы открыты. Это означает, что вы можете добавлять к ним свойства из любого места, просто переопределяя их.

Учитывая, что вы используете этот файл express.d.ts , у вас должна быть возможность переопределить интерфейс запроса, чтобы добавить дополнительное поле.

interface Request {
  property: string;
}

Затем в вашей функции промежуточного программного обеспечения параметр req также должен иметь это свойство. Вы сможете использовать его без каких-либо изменений в вашем коде.

Хотя это очень старый вопрос, я недавно наткнулся на эту проблему. Принятый ответ работает нормально, но мне нужно было добавить настраиваемый интерфейс Request- интерфейс, который я использовал в своем коде, и который не работал так хорошо с принятым ответ. По логике, я попробовал это:

import ITenant from "../interfaces/ITenant";

declare namespace Express {
    export interface Request {
        tenant?: ITenant;
    }
}

Но это не сработало, потому что Typescript обрабатывает .d.tsфайлы как глобальный импорт, и когда в них есть импорт, они рассматриваются как обычные модули. Вот почему приведенный выше код не работает со стандартной настройкой машинописного текста.

Вот что я в итоге сделал

// typings/common.d.ts

declare namespace Express {
    export interface Request {
        tenant?: import("../interfaces/ITenant").default;
    }
}

// interfaces/ITenant.ts

export interface ITenant {
    ...
}

Возможно, на этот вопрос был дан ответ, но я хочу немного поделиться, теперь иногда интерфейс, такой как другие ответы, может быть слишком ограничительным, но мы действительно можем поддерживать необходимые свойства, а затем добавлять любые дополнительные свойства, создавая ключ с типом stringс типом значенияany

import { Request, Response, NextFunction } from 'express'

interface IRequest extends Request {
  [key: string]: any
}

app.use( (req: IRequest, res: Response, next: NextFunction) => {
  req.property = setProperty();

  next();
});

Итак, теперь мы также можем добавить к этому объекту любое дополнительное свойство, которое захотим.

Все эти ответы кажутся ошибочными или устаревшими в той или иной степени.

Это сработало для меня в мае 2020 года:

в ${PROJECT_ROOT}/@types/express/index.d.ts:

import * as express from "express"

declare global {
    namespace Express {
        interface Request {
            my_custom_property: TheCustomType
        }
    }
}

in tsconfig.jsonдобавьте / объедините свойство таким образом, чтобы:

"typeRoots": [ "@types" ]

Приветствия.

Если вы ищете решение, которое работает с express4, вот оно:

@ types / express / index.d.ts: -------- должно быть /index.d.ts

declare namespace Express { // must be namespace, and not declare module "Express" { 
  export interface Request {
    user: any;
  }
}

tsconfig.json:

{
  "compilerOptions": {
    "module": "commonjs",
    "target": "es2016",
    "typeRoots" : [
      "@types", // custom merged types must be first in a list
      "node_modules/@types",
    ]
  }
}

Ссылка с https://github.com/TypeStrong/ts-node/issues/715#issuecomment-526757308

Одно из возможных решений - использовать «двойное приведение к любому».

1- определить интерфейс с вашей собственностью

export interface MyRequest extends http.IncomingMessage {
     myProperty: string
}

2- двойной заброс

app.use((req: http.IncomingMessage, res: http.ServerResponse, next: (err?: Error) => void) => {
    const myReq: MyRequest = req as any as MyRequest
    myReq.myProperty = setProperty()
    next()
})

Преимущества двойного литья:

• доступен набор текста
• он не загрязняет существующие определения, а расширяет их, избегая путаницы
• поскольку приведение явное, он компилирует штрафы с -noImplicitanyфлагом

В качестве альтернативы есть быстрый (нетипизированный) маршрут:

 req['myProperty'] = setProperty()

(не редактируйте существующие файлы определений своими собственными свойствами - это невозможно поддерживать. Если определения неверны, откройте запрос на перенос)

РЕДАКТИРОВАТЬ

См. Комментарий ниже, в этом случае работает простой кастинг req as MyRequest

Этот ответ будет полезен тем, кто полагается на пакет npm ts-node .

Я также боролся с той же проблемой расширения запроса объекта , я следил за множеством ответов в переполнении стека и закончил, следуя указанной ниже стратегии.

Я объявил расширенную типизацию для экспресс в следующем каталоге.${PROJECT_ROOT}/api/@types/express/index.d.ts

declare namespace Express {
  interface Request {
    decoded?: any;
  }
}

затем обновите мой tsconfig.jsonдо чего-то вроде этого.

{
  "compilerOptions": {
     "typeRoots": ["api/@types", "node_modules/@types"]
      ...
  }
}

даже после выполнения описанных выше шагов визуальная студия перестала жаловаться, но, к сожалению, ts-nodeкомпилятор все еще бросал.

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

По-видимому, ts-nodeне удалось найти определения расширенного типа для запроса объекта .

В конце концов, потратив часы, я знал, что VS Code не жаловался и смог найти определения ввода, подразумевая, что что-то не так с ts-node complier.

Обновление начало scriptв package.jsonфиксированной для меня.

"start": "ts-node --files api/index.ts",

что --filesаргументы играют ключевую роль здесь найти определение пользовательских определений типа.

Для получения дополнительной информации посетите: https://github.com/TypeStrong/ts-node#help-my-types-are-missing

Чтобы помочь всем, кто просто ищет что-то еще, чтобы попробовать, вот что у меня сработало в конце мая 2020 года, когда я пытался расширить запрос ExpressJS. Мне пришлось перепробовать более дюжины вещей, прежде чем это заработало:

• Измените порядок того, что все рекомендуют в «typeRoots» вашего tsconfig.json (и не забудьте отказаться от пути src, если у вас есть параметр rootDir в tsconfig, такой как «./src»). Пример:

"typeRoots": [
      "./node_modules/@types",
      "./your-custom-types-dir"
]

• Пример настраиваемого расширения ('./your-custom-types-dir/express/index.d.ts "). Мне пришлось использовать встроенный импорт и экспорт по умолчанию, чтобы использовать классы в качестве типа в моем опыте, так что это тоже показано:

declare global {
  namespace Express {
    interface Request {
      customBasicProperty: string,
      customClassProperty: import("../path/to/CustomClass").default;
    }
  }
}

• Обновите файл nodemon.json, чтобы добавить команду "--files" в ts-node, например:

{
  "restartable": "rs",
  "ignore": [".git", "node_modules/**/node_modules"],
  "verbose": true,
  "exec": "ts-node --files",
  "watch": ["src/"],
  "env": {
    "NODE_ENV": "development"
  },
  "ext": "js,json,ts"
}

Может быть, уже довольно поздно для этого ответа, но в любом случае вот как я решил:

1. Убедитесь, что в ваш tsconfigфайл включен источник ваших типов (это может быть совершенно новый поток)
2. Внутри каталога типов добавьте новый каталог и назовите его как пакет, для которого вы хотите расширить или создать типы. В этом конкретном случае вы создадите каталог с именемexpress
3. Внутри expressкаталога создайте файл и назовите его index.d.ts(ДОЛЖЕН БЫТЬ ТОЧНО ТАК)
4. Наконец, чтобы сделать расширение типов, вам просто нужно поместить код, подобный следующему:

declare module 'express' {
    export interface Request {
        property?: string;
    }
}

зачем нам столько хлопот, как в принятых выше ответах, когда мы можем уйти от этого

вместо того, чтобы прикреплять наше свойство к запросу , мы можем прикрепить его к заголовкам запроса

   req.headers[property] = "hello"