Skip to content

Commit f4b4e2a

Browse files
authored
docs: add documentation for destroy method (#2204)
1 parent a990db7 commit f4b4e2a

File tree

252 files changed

+1260
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

252 files changed

+1260
-0
lines changed

clients/client-accessanalyzer/AccessAnalyzerClient.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -268,6 +268,11 @@ export class AccessAnalyzerClient extends __Client<
268268
this.middlewareStack.use(getUserAgentPlugin(this.config));
269269
}
270270

271+
/**
272+
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
273+
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
274+
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
275+
*/
271276
destroy(): void {
272277
super.destroy();
273278
}

clients/client-acm-pca/ACMPCAClient.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -322,6 +322,11 @@ export class ACMPCAClient extends __Client<
322322
this.middlewareStack.use(getUserAgentPlugin(this.config));
323323
}
324324

325+
/**
326+
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
327+
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
328+
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
329+
*/
325330
destroy(): void {
326331
super.destroy();
327332
}

clients/client-acm/ACMClient.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -261,6 +261,11 @@ export class ACMClient extends __Client<
261261
this.middlewareStack.use(getUserAgentPlugin(this.config));
262262
}
263263

264+
/**
265+
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
266+
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
267+
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
268+
*/
264269
destroy(): void {
265270
super.destroy();
266271
}

clients/client-alexa-for-business/AlexaForBusinessClient.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -602,6 +602,11 @@ export class AlexaForBusinessClient extends __Client<
602602
this.middlewareStack.use(getUserAgentPlugin(this.config));
603603
}
604604

605+
/**
606+
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
607+
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
608+
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
609+
*/
605610
destroy(): void {
606611
super.destroy();
607612
}

clients/client-amplify/AmplifyClient.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -345,6 +345,11 @@ export class AmplifyClient extends __Client<
345345
this.middlewareStack.use(getUserAgentPlugin(this.config));
346346
}
347347

348+
/**
349+
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
350+
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
351+
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
352+
*/
348353
destroy(): void {
349354
super.destroy();
350355
}

clients/client-amplifybackend/AmplifyBackendClient.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -286,6 +286,11 @@ export class AmplifyBackendClient extends __Client<
286286
this.middlewareStack.use(getUserAgentPlugin(this.config));
287287
}
288288

289+
/**
290+
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
291+
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
292+
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
293+
*/
289294
destroy(): void {
290295
super.destroy();
291296
}

clients/client-api-gateway/APIGatewayClient.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -670,6 +670,11 @@ export class APIGatewayClient extends __Client<
670670
this.middlewareStack.use(getUserAgentPlugin(this.config));
671671
}
672672

673+
/**
674+
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
675+
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
676+
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
677+
*/
673678
destroy(): void {
674679
super.destroy();
675680
}

clients/client-apigatewaymanagementapi/ApiGatewayManagementApiClient.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -205,6 +205,11 @@ export class ApiGatewayManagementApiClient extends __Client<
205205
this.middlewareStack.use(getUserAgentPlugin(this.config));
206206
}
207207

208+
/**
209+
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
210+
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
211+
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
212+
*/
208213
destroy(): void {
209214
super.destroy();
210215
}

clients/client-apigatewayv2/ApiGatewayV2Client.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -454,6 +454,11 @@ export class ApiGatewayV2Client extends __Client<
454454
this.middlewareStack.use(getUserAgentPlugin(this.config));
455455
}
456456

457+
/**
458+
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
459+
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
460+
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
461+
*/
457462
destroy(): void {
458463
super.destroy();
459464
}

clients/client-app-mesh/AppMeshClient.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -376,6 +376,11 @@ export class AppMeshClient extends __Client<
376376
this.middlewareStack.use(getUserAgentPlugin(this.config));
377377
}
378378

379+
/**
380+
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
381+
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
382+
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
383+
*/
379384
destroy(): void {
380385
super.destroy();
381386
}

0 commit comments

Comments
 (0)