Add .off() method for events (#2092)

Rychu-Pawel · web-flow · commit 88056bed05ad · 2022-07-28T12:09:04.000+02:00
diff --git a/documentation/1-promise.md b/documentation/1-promise.md
@@ -89,3 +89,28 @@ Whether the promise is canceled.
 ### `promise.on(event, handler)`
 
 The events are the same as in [Stream API](3-streams.md#events).
+
+### `promise.off(event, handler)`
+
+Removes listener registered with [`promise.on`](1-promise.md#promiseonevent-handler)
+
+```js
+import {createReadStream} from 'node:fs';
+import got from 'got';
+
+const ongoingRequestPromise = got.post(uploadUrl, {
+    body: createReadStream('sample.txt')
+});
+
+const eventListener = (progress: Progress) => {
+    console.log(progress);
+};
+
+ongoingRequestPromise.on('uploadProgress', eventListener);
+
+setTimeout(() => {
+    ongoingRequestPromise.off('uploadProgress', eventListener);
+}, 500);
+
+await ongoingRequestPromise;
+```
diff --git a/source/as-promise/index.ts b/source/as-promise/index.ts
@@ -170,6 +170,11 @@ export default function asPromise<T>(firstRequest?: Request): CancelableRequest<
 		return promise;
 	};
 
+	promise.off = (event: string, fn: (...args: any[]) => void) => {
+		emitter.off(event, fn);
+		return promise;
+	};
+
 	const shortcut = <T>(responseType: Options['responseType']): CancelableRequest<T> => {
 		const newPromise = (async () => {
 			// Wait until downloading has ended
diff --git a/source/core/index.ts b/source/core/index.ts
@@ -117,6 +117,7 @@ export type GotEventFunction<T> =
 export interface RequestEvents<T> {
 	on: GotEventFunction<T>;
 	once: GotEventFunction<T>;
+	off: GotEventFunction<T>;
 }
 
 export type CacheableRequestFunction = (
diff --git a/test/progress.ts b/test/progress.ts
@@ -221,3 +221,44 @@ test('upload progress - no body', withServer, async (t, server, got) => {
 		},
 	]);
 });
+
+test('upload progress - no events when immediatly removed listener', withServer, async (t, server, got) => {
+	server.post('/', uploadEndpoint);
+
+	const events: Progress[] = [];
+
+	const listener = (event: Progress) => events.push(event);
+
+	const promise = got.post('')
+		.on('uploadProgress', listener)
+		.off('uploadProgress', listener);
+
+	await promise;
+
+	t.is(events.length, 0);
+});
+
+test('upload progress - one event when removed listener', withServer, async (t, server, got) => {
+	server.post('/', uploadEndpoint);
+
+	const events: Progress[] = [];
+
+	const promise = got.post('');
+
+	const listener = (event: Progress) => {
+		events.push(event);
+		void promise.off('uploadProgress', listener);
+	};
+
+	void promise.on('uploadProgress', listener);
+
+	await promise;
+
+	t.deepEqual(events, [
+		{
+			percent: 0,
+			transferred: 0,
+			total: undefined,
+		},
+	]);
+});

Original file line number	Diff line number	Diff line change
`@@ -117,6 +117,7 @@ export type GotEventFunction<T> =`
`117`	`117`	`export interface RequestEvents<T> {`
`118`	`118`	`on: GotEventFunction<T>;`
`119`	`119`	`once: GotEventFunction<T>;`
	`120`	`+ off: GotEventFunction<T>;`
`120`	`121`	`}`
`121`	`122`
`122`	`123`	`export type CacheableRequestFunction = (`