Set request.timings and response.timings

Author: szmarczak

README.md

@@ -19,7 +19,6 @@ Yarn:
 
 ## Usage
 ```js
-'use strict';
 const https = require('https');
 const timer = require('@szmarczak/http-timer');
 
@@ -83,6 +82,27 @@ If something has not been measured yet, it will be `undefined`.
 
 **Note**: The time is a `number` representing the milliseconds elapsed since the UNIX epoch.
 
+You can also access the timings through `request.timings` or `response.timings`:
+
+```js
+const https = require('https');
+const timer = require('@szmarczak/http-timer');
+
+const request = https.get('https://httpbin.org/anything');
+const timings = timer(request);
+
+console.log(request.timings === timings);
+// => true
+
+request.on('response', response => {
+	response.on('data', () => {}); // Consume the data somehow
+	response.on('end', () => {
+		console.log(response.timings === timings);
+		// => true
+	});
+});
+```
+
 ## License
 
 MIT

source/index.ts

@@ -25,6 +25,16 @@ export interface Timings {
 	};
 }
 
+declare module 'http' {
+	interface ClientRequest {
+		timings?: Timings;
+	}
+
+	interface IncomingMessage {
+		timings?: Timings;
+	}
+}
+
 const timer = (request: ClientRequest): Timings => {
 	const timings: Timings = {
 		start: Date.now(),
@@ -48,6 +58,8 @@ const timer = (request: ClientRequest): Timings => {
 		}
 	};
 
+	request.timings = timings;
+
 	const handleError = (origin: EventEmitter): void => {
 		const emit = origin.emit.bind(origin);
 		origin.emit = (event, ...args) => {
@@ -108,6 +120,8 @@ const timer = (request: ClientRequest): Timings => {
 		timings.response = Date.now();
 		timings.phases.firstByte = timings.response - timings.upload!;
 
+		response.timings = timings;
+
 		handleError(response);
 
 		response.prependOnceListener('end', () => {

test.ts

@@ -222,3 +222,20 @@ test('no `tls` phase for http requests', async t => {
 	t.is(timings.secureConnect, undefined);
 	t.is(timings.phases.tls, undefined);
 });
+
+test('timings are accessible via `request.timings`', t => {
+	const {request, timings} = makeRequest('https://google.com');
+	request.abort();
+
+	t.is(request.timings, timings);
+});
+
+test('timings are accessible via `response.timings`', async t => {
+	const {request, timings} = makeRequest('https://google.com');
+
+	const response = await pEvent(request, 'response');
+	t.is(response.timings, timings);
+
+	response.resume();
+	await pEvent(response, 'end');
+});