Skip to content

Commit 66067d3

Browse files
chore(types): add | undefined to client options properties (#1264)
1 parent 5df7738 commit 66067d3

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

src/index.ts

+6-6
Original file line numberDiff line numberDiff line change
@@ -137,15 +137,15 @@ export interface ClientOptions {
137137
* Note that request timeouts are retried by default, so in a worst-case scenario you may wait
138138
* much longer than this timeout before the promise succeeds or fails.
139139
*/
140-
timeout?: number;
140+
timeout?: number | undefined;
141141

142142
/**
143143
* An HTTP agent used to manage HTTP(S) connections.
144144
*
145145
* If not provided, an agent will be constructed by default in the Node.js environment,
146146
* otherwise no agent is used.
147147
*/
148-
httpAgent?: Agent;
148+
httpAgent?: Agent | undefined;
149149

150150
/**
151151
* Specify a custom `fetch` function implementation.
@@ -161,29 +161,29 @@ export interface ClientOptions {
161161
*
162162
* @default 2
163163
*/
164-
maxRetries?: number;
164+
maxRetries?: number | undefined;
165165

166166
/**
167167
* Default headers to include with every request to the API.
168168
*
169169
* These can be removed in individual requests by explicitly setting the
170170
* header to `undefined` or `null` in request options.
171171
*/
172-
defaultHeaders?: Core.Headers;
172+
defaultHeaders?: Core.Headers | undefined;
173173

174174
/**
175175
* Default query parameters to include with every request to the API.
176176
*
177177
* These can be removed in individual requests by explicitly setting the
178178
* param to `undefined` in request options.
179179
*/
180-
defaultQuery?: Core.DefaultQuery;
180+
defaultQuery?: Core.DefaultQuery | undefined;
181181

182182
/**
183183
* By default, client-side use of this library is not allowed, as it risks exposing your secret API credentials to attackers.
184184
* Only set this option to `true` if you understand the risks and have appropriate mitigations in place.
185185
*/
186-
dangerouslyAllowBrowser?: boolean;
186+
dangerouslyAllowBrowser?: boolean | undefined;
187187
}
188188

189189
/**

0 commit comments

Comments
 (0)