Skip to content

Commit 567a589

Browse files
mcollinaclaude
mcollina
and
claude
authored
fix: remove deprecated maxRedirections option from types (#4363)
* fix: remove deprecated maxRedirections option from types The maxRedirections option was removed in v7 but still remained in TypeScript type definitions. This removes it from: - Agent.Options and Agent.DispatchOptions - Dispatcher ConnectOptions, RequestOptions, and UpgradeOptions - Client.Options and H2CClient.Options - MockInterceptor.MockResponseCallbackOptions Also updates corresponding type tests to remove usage of the deprecated option. The redirect interceptor still supports maxRedirections as that functionality remains available. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> Signed-off-by: Matteo Collina <hello@matteocollina.com> * fixup Signed-off-by: Matteo Collina <hello@matteocollina.com> --------- Signed-off-by: Matteo Collina <hello@matteocollina.com> Co-authored-by: Claude <noreply@anthropic.com>
1 parent 177ca1b commit 567a589

11 files changed

Lines changed: 10 additions & 30 deletions

‎test/types/agent.test-d.ts‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ import { URL } from 'url'
55

66
expectAssignable<Agent>(new Agent())
77
expectAssignable<Agent>(new Agent({}))
8-
expectAssignable<Agent>(new Agent({ maxRedirections: 1 }))
98
expectAssignable<Agent>(new Agent({ factory: () => new Dispatcher() }))
109

1110
{
@@ -99,7 +98,6 @@ expectAssignable<Agent>(new Agent({ factory: () => new Dispatcher() }))
9998

10099
// dispatch
101100
expectAssignable<boolean>(agent.dispatch({ origin: '', path: '', method: 'GET' }, {}))
102-
expectAssignable<boolean>(agent.dispatch({ origin: '', path: '', method: 'GET', maxRedirections: 1 }, {}))
103101

104102
// close
105103
expectAssignable<Promise<void>>(agent.close())

‎test/types/client.test-d.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ expectAssignable<Client>(
7777
)
7878
expectAssignable<Client>(
7979
new Client('', {
80-
maxRedirections: 1
80+
maxCachedSessions: 1
8181
})
8282
)
8383
expectAssignable<Client>(

‎test/types/dispatcher.test-d.ts‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@ expectAssignable<Dispatcher>(new Dispatcher())
4646
expectAssignable<boolean>(dispatcher.dispatch({ path: '', method: 'CUSTOM' }, {}))
4747

4848
// connect
49-
expectAssignable<Promise<Dispatcher.ConnectData>>(dispatcher.connect({ origin: '', path: '', maxRedirections: 0 }))
50-
expectAssignable<Promise<Dispatcher.ConnectData>>(dispatcher.connect({ origin: new URL('http://localhost'), path: '', maxRedirections: 0 }))
49+
expectAssignable<Promise<Dispatcher.ConnectData>>(dispatcher.connect({ origin: '', path: '' }))
50+
expectAssignable<Promise<Dispatcher.ConnectData>>(dispatcher.connect({ origin: new URL('http://localhost'), path: '' }))
5151
expectAssignable<void>(dispatcher.connect({ origin: '', path: '' }, (err, data) => {
5252
expectAssignable<Error | null>(err)
5353
expectAssignable<Dispatcher.ConnectData>(data)
@@ -73,10 +73,10 @@ expectAssignable<Dispatcher>(new Dispatcher())
7373
expectAssignable<Promise<Dispatcher.ConnectData>>(dispatcher.connect({ origin: '', path: '', headers: iteratorHeaders }))
7474

7575
// request
76-
expectAssignable<Promise<Dispatcher.ResponseData>>(dispatcher.request({ origin: '', path: '', method: 'GET', maxRedirections: 0 }))
77-
expectAssignable<Promise<Dispatcher.ResponseData>>(dispatcher.request({ origin: '', path: '', method: 'GET', maxRedirections: 0, query: {} }))
78-
expectAssignable<Promise<Dispatcher.ResponseData>>(dispatcher.request({ origin: '', path: '', method: 'GET', maxRedirections: 0, query: { pageNum: 1, id: 'abc' } }))
79-
expectAssignable<Promise<Dispatcher.ResponseData>>(dispatcher.request({ origin: '', path: '', method: 'GET', maxRedirections: 0, throwOnError: true }))
76+
expectAssignable<Promise<Dispatcher.ResponseData>>(dispatcher.request({ origin: '', path: '', method: 'GET' }))
77+
expectAssignable<Promise<Dispatcher.ResponseData>>(dispatcher.request({ origin: '', path: '', method: 'GET', query: {} }))
78+
expectAssignable<Promise<Dispatcher.ResponseData>>(dispatcher.request({ origin: '', path: '', method: 'GET', query: { pageNum: 1, id: 'abc' } }))
79+
expectAssignable<Promise<Dispatcher.ResponseData>>(dispatcher.request({ origin: '', path: '', method: 'GET', throwOnError: true }))
8080
expectAssignable<Promise<Dispatcher.ResponseData>>(dispatcher.request({ origin: new URL('http://localhost'), path: '', method: 'GET' }))
8181
expectAssignable<void>(dispatcher.request({ origin: '', path: '', method: 'GET', reset: true }, (err, data) => {
8282
expectAssignable<Error | null>(err)
@@ -91,7 +91,7 @@ expectAssignable<Dispatcher>(new Dispatcher())
9191
expectAssignable<Promise<Dispatcher.ResponseData<{ example: string }>>>(dispatcher.request({ origin: '', path: '', method: 'GET', opaque: { example: '' } }))
9292

9393
// pipeline
94-
expectAssignable<Duplex>(dispatcher.pipeline({ origin: '', path: '', method: 'GET', maxRedirections: 0 }, data => {
94+
expectAssignable<Duplex>(dispatcher.pipeline({ origin: '', path: '', method: 'GET' }, data => {
9595
expectAssignable<Dispatcher.PipelineHandlerData>(data)
9696
return new Readable()
9797
}))
@@ -114,7 +114,7 @@ expectAssignable<Dispatcher>(new Dispatcher())
114114
}))
115115

116116
// stream
117-
expectAssignable<Promise<Dispatcher.StreamData>>(dispatcher.stream({ origin: '', path: '', method: 'GET', maxRedirections: 0 }, data => {
117+
expectAssignable<Promise<Dispatcher.StreamData>>(dispatcher.stream({ origin: '', path: '', method: 'GET' }, data => {
118118
expectAssignable<Dispatcher.StreamFactoryData>(data)
119119
return new Writable()
120120
}))
@@ -170,7 +170,7 @@ expectAssignable<Dispatcher>(new Dispatcher())
170170
}))
171171

172172
// upgrade
173-
expectAssignable<Promise<Dispatcher.UpgradeData>>(dispatcher.upgrade({ path: '', maxRedirections: 0 }))
173+
expectAssignable<Promise<Dispatcher.UpgradeData>>(dispatcher.upgrade({ path: '' }))
174174
expectAssignable<void>(dispatcher.upgrade({ path: '' }, (err, data) => {
175175
expectAssignable<Error | null>(err)
176176
expectAssignable<Dispatcher.UpgradeData>(data)

‎test/types/env-http-proxy-agent.test-d.ts‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,6 @@ expectAssignable<EnvHttpProxyAgent>(new EnvHttpProxyAgent({ httpProxy: 'http://l
9494

9595
// dispatch
9696
expectAssignable<boolean>(agent.dispatch({ origin: '', path: '', method: 'GET' }, {}))
97-
expectAssignable<boolean>(agent.dispatch({ origin: '', path: '', method: 'GET', maxRedirections: 1 }, {}))
9897

9998
// close
10099
expectAssignable<Promise<void>>(agent.close())

‎test/types/mock-interceptor.test-d.ts‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,6 @@ expectAssignable<BodyInit | Dispatcher.DispatchOptions['body']>(mockResponseCall
5252
expectAssignable<MockInterceptor.MockResponseCallbackOptions['headers']>(options.headers)
5353
expectAssignable<MockInterceptor.MockResponseCallbackOptions['origin']>(options.origin)
5454
expectAssignable<MockInterceptor.MockResponseCallbackOptions['body']>(options.body)
55-
expectAssignable<MockInterceptor.MockResponseCallbackOptions['maxRedirections']>(options.maxRedirections)
5655
return { statusCode: 200, data: { foo: 'bar' } }
5756
})
5857

‎test/types/proxy-agent.test-d.ts‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ expectAssignable<ProxyAgent>(
1010
uri: '',
1111
auth: '',
1212
token: '',
13-
maxRedirections: 1,
1413
factory: (_origin: URL, opts: Object) => new Agent(opts),
1514
requestTls: {
1615
ca: [''],

‎types/agent.d.ts‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,10 @@ declare namespace Agent {
2222
export interface Options extends Pool.Options {
2323
/** Default: `(origin, opts) => new Pool(origin, opts)`. */
2424
factory?(origin: string | URL, opts: Object): Dispatcher;
25-
/** Integer. Default: `0` */
26-
maxRedirections?: number;
2725

2826
interceptors?: { Agent?: readonly Dispatcher.DispatchInterceptor[] } & Pool.Options['interceptors']
2927
}
3028

3129
export interface DispatchOptions extends Dispatcher.DispatchOptions {
32-
/** Integer. */
33-
maxRedirections?: number;
3430
}
3531
}

‎types/client.d.ts‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,6 @@ export declare namespace Client {
7171
/** TODO */
7272
maxCachedSessions?: number;
7373
/** TODO */
74-
maxRedirections?: number;
75-
/** TODO */
7674
connect?: Partial<buildConnector.BuildOptions> | buildConnector.connector;
7775
/** TODO */
7876
maxRequestsPerClient?: number;

‎types/dispatcher.d.ts‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -135,8 +135,6 @@ declare namespace Dispatcher {
135135
signal?: AbortSignal | EventEmitter | null;
136136
/** This argument parameter is passed through to `ConnectData` */
137137
opaque?: TOpaque;
138-
/** Default: 0 */
139-
maxRedirections?: number;
140138
/** Default: false */
141139
redirectionLimitReached?: boolean;
142140
/** Default: `null` */
@@ -147,8 +145,6 @@ declare namespace Dispatcher {
147145
opaque?: TOpaque;
148146
/** Default: `null` */
149147
signal?: AbortSignal | EventEmitter | null;
150-
/** Default: 0 */
151-
maxRedirections?: number;
152148
/** Default: false */
153149
redirectionLimitReached?: boolean;
154150
/** Default: `null` */
@@ -172,8 +168,6 @@ declare namespace Dispatcher {
172168
protocol?: string;
173169
/** Default: `null` */
174170
signal?: AbortSignal | EventEmitter | null;
175-
/** Default: 0 */
176-
maxRedirections?: number;
177171
/** Default: false */
178172
redirectionLimitReached?: boolean;
179173
/** Default: `null` */

‎types/h2c-client.d.ts‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,6 @@ export declare namespace H2CClient {
5151
/** TODO */
5252
maxCachedSessions?: number;
5353
/** TODO */
54-
maxRedirections?: number;
55-
/** TODO */
5654
connect?: Omit<Partial<buildConnector.BuildOptions>, 'allowH2'> | buildConnector.connector;
5755
/** TODO */
5856
maxRequestsPerClient?: number;

0 commit comments

Comments
 (0)