Make got.paginate() an alias for got.paginate.each()

Fixes #1195
sindresorhus · May 12, 2020 · 5480b31 · 5480b31 · szmarczak · May 14, 2020
1 parent 6f84051
commit 5480b31
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 7 deletions.
diff --git a/source/create.ts b/source/create.ts
@@ -110,6 +110,7 @@ const create = (defaults: InstanceDefaults): Got => {
 		return result;
 	}));
 
+	// Got interface
 	const got: Got = ((url: string | URL, options?: Options): GotReturn => {
 		let iteration = 0;
 		const iterateHandlers = (newOptions: NormalizedOptions): GotReturn => {
@@ -190,7 +191,8 @@ const create = (defaults: InstanceDefaults): Got => {
 		});
 	};
 
-	got.paginate = (async function * <T, R>(url: string | URL, options?: OptionsWithPagination<T, R>) {
+	// Pagination
+	const paginateEach = (async function * <T, R>(url: string | URL, options?: OptionsWithPagination<T, R>) {
 		let normalizedOptions = normalizeArguments(url, options, defaults.options);
 		normalizedOptions.resolveBodyOnly = false;
 
@@ -247,6 +249,10 @@ const create = (defaults: InstanceDefaults): Got => {
 
 			numberOfRequests++;
 		}
+	});
+
+	got.paginate = (<T, R>(url: string | URL, options?: OptionsWithPagination<T, R>) => {
+		return paginateEach(url, options);
 	}) as GotPaginate;
 
 	got.paginate.all = (async <T, R>(url: string | URL, options?: OptionsWithPagination<T, R>) => {
@@ -259,8 +265,13 @@ const create = (defaults: InstanceDefaults): Got => {
 		return results;
 	}) as GotPaginate['all'];
 
+	// For those who like very descriptive names
+	got.paginate.each = paginateEach as GotPaginate['each'];
+
+	// Stream API
 	got.stream = ((url: string | URL, options?: StreamOptions) => got(url, {...options, isStream: true})) as GotStream;
 
+	// Shortcuts
 	for (const method of aliases) {
 		got[method] = ((url: string | URL, options?: Options): GotReturn => got(url, {...options, method})) as GotRequestFunction;
 

diff --git a/source/types.ts b/source/types.ts
@@ -52,13 +52,12 @@ export type OptionsWithPagination<T = unknown, R = unknown> = Merge<Options, Pag
 
 export interface GotPaginate {
 	<T, R = unknown>(url: string | URL, options?: OptionsWithPagination<T, R>): AsyncIterableIterator<T>;
-	all<T, R = unknown>(url: string | URL, options?: OptionsWithPagination<T, R>): Promise<T[]>;
-
-	// A bug.
-	// eslint-disable-next-line @typescript-eslint/adjacent-overload-signatures
 	<T, R = unknown>(options?: OptionsWithPagination<T, R>): AsyncIterableIterator<T>;
-	// A bug.
-	// eslint-disable-next-line @typescript-eslint/adjacent-overload-signatures
+
+	each<T, R = unknown>(url: string | URL, options?: OptionsWithPagination<T, R>): AsyncIterableIterator<T>;
+	each<T, R = unknown>(options?: OptionsWithPagination<T, R>): AsyncIterableIterator<T>;
+
+	all<T, R = unknown>(url: string | URL, options?: OptionsWithPagination<T, R>): Promise<T[]>;
 	all<T, R = unknown>(options?: OptionsWithPagination<T, R>): Promise<T[]>;
 }
 

diff --git a/test/pagination.ts b/test/pagination.ts
@@ -190,6 +190,18 @@ test('iterator works', withServer, async (t, server, got) => {
 	t.deepEqual(results, [1, 2, 3, 4, 5]);
 });
 
+test('iterator works #2', withServer, async (t, server, got) => {
+	attachHandler(server, 5);
+
+	const results: number[] = [];
+
+	for await (const item of got.paginate.each<number>('')) {
+		results.push(item);
+	}
+
+	t.deepEqual(results, [1, 2, 3, 4, 5]);
+});
+
 test('`shouldContinue` works', withServer, async (t, server, got) => {
 	attachHandler(server, 2);