Erweitern express.Anfrage im Projekt

Question

Ich bin neu in Typescript, also ertragen Sie mit mir.

Ich arbeite an einem Express-basierten Web-Service. Ich möchte, dass ein Teil der frühen Middleware ein Logging-Objekt auf das Request-Objekt setzt und später im Request-Handler-Flow verwendet.

Die Middleware und der letzte Anforderungshandler sind in verschiedenen Dateien organisiert.

Was wäre die beste Möglichkeit, das express.Request-Objekt zentral zu erweitern, um die Verwendung dieses Logging-Objekts zu ermöglichen, ohne dass es Warntypen gibt?

Nur um zu zeigen, was ich habe und will:

Die Datei, die mein Log-Objekt Express- und setzt instanziiert:

const app = express(); 
const log = console; 

app.use((req: express.Request, res: express.Response, next: express.NextFunction) => { 
    req.log = log; 
    next(); 
}); 

Ein Request-Handler:

(req: express.Request, res: express.Response): void => { 
    req.log("request was made"); 
    res.send(); 
} 

Answer 1

Sie die verlängern express.Request Objekt wie folgt:

declare global { 
    namespace Express { 
    interface Request { 
     log(...params: any[]): void 
    } 
    } 
} 

Oder, wenn Sie eine deutlichere Unterscheidung zwischen der Vanille Request Typ und Augmented-Version machen wollen, können Sie etwas tun könnte:

interface RequestWithLogging extends express.Request { 
    log(...params: any[]): void 
} 

app.get('/', (req: RequestWithLogging, res: express.Response) => { 
    req.log('Log something') 
    res.send('Hello World!') 
})