diff --git a/source/core/options.ts b/source/core/options.ts index 556744dc5..ffacce916 100644 --- a/source/core/options.ts +++ b/source/core/options.ts @@ -425,13 +425,13 @@ export interface PaginationOptions { const limit = 10; const items = got.paginate('https://example.com/items', { - searchParameters: { + searchParams: { limit, offset: 0 }, pagination: { paginate: ({response, currentItems}) => { - const previousSearchParams = response.request.options.searchParameters; + const previousSearchParams = response.request.options.searchParams; const previousOffset = previousSearchParams.get('offset'); if (currentItems.length < limit) { @@ -439,7 +439,7 @@ export interface PaginationOptions { } return { - searchParameters: { + searchParams: { ...previousSearchParams, offset: Number(previousOffset) + limit, } @@ -707,10 +707,10 @@ const defaultInternals: Options['_internals'] = { maxHeaderSize: undefined, }; -const cloneInternals = (internals: typeof defaultInternals): typeof defaultInternals => { +const cloneInternals = (internals: typeof defaultInternals) => { const {hooks, retry} = internals; - const result = { + const result: typeof defaultInternals = { ...internals, context: {...internals.context}, cacheOptions: {...internals.cacheOptions}, @@ -732,7 +732,7 @@ const cloneInternals = (internals: typeof defaultInternals): typeof defaultInter beforeRetry: [...hooks.beforeRetry], afterResponse: [...hooks.afterResponse], }, - searchParameters: internals.searchParams ? new URLSearchParams(internals.searchParams as URLSearchParams) : undefined, + searchParams: internals.searchParams ? new URLSearchParams(internals.searchParams as URLSearchParams) : undefined, pagination: {...internals.pagination}, }; @@ -1176,10 +1176,10 @@ export default class Options { @example ``` await got('https://example.com/?query=a b'); //=> https://example.com/?query=a%20b - await got('https://example.com/', {searchParameters: {query: 'a b'}}); //=> https://example.com/?query=a+b + await got('https://example.com/', {searchParams: {query: 'a b'}}); //=> https://example.com/?query=a+b - // The query string is overridden by `searchParameters` - await got('https://example.com/?query=a b', {searchParameters: {query: 'a b'}}); //=> https://example.com/?query=a+b + // The query string is overridden by `searchParams` + await got('https://example.com/?query=a b', {searchParams: {query: 'a b'}}); //=> https://example.com/?query=a+b ``` */ get url(): string | URL | undefined { @@ -1312,11 +1312,11 @@ export default class Options { ``` import got from 'got'; - const searchParameters = new URLSearchParams([['key', 'a'], ['key', 'b']]); + const searchParams = new URLSearchParams([['key', 'a'], ['key', 'b']]); - await got('https://example.com', {searchParameters}); + await got('https://example.com', {searchParams}); - console.log(searchParameters.toString()); + console.log(searchParams.toString()); //=> 'key=a&key=b' ``` */ diff --git a/test/normalize-arguments.ts b/test/normalize-arguments.ts index 4930a0ec7..dc0edcc55 100644 --- a/test/normalize-arguments.ts +++ b/test/normalize-arguments.ts @@ -152,18 +152,18 @@ test('extending responseType', t => { }); test('searchParams - multiple values for one key', t => { - const searchParams = new URLSearchParams(); + const searchParameters = new URLSearchParams(); - searchParams.append('a', '100'); - searchParams.append('a', '200'); - searchParams.append('a', '300'); + searchParameters.append('a', '100'); + searchParameters.append('a', '200'); + searchParameters.append('a', '300'); const options = new Options({ - searchParams + searchParams: searchParameters, }); t.deepEqual( (options.searchParams as URLSearchParams).getAll('a'), - ['100', '200', '300'] + ['100', '200', '300'], ); });