chore: doc populateAbortErrorResponse

discordjs · Jun 5, 2022 · d1832eb · d1832eb
1 parent bac20e8
commit d1832eb
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/packages/proxy/src/util/responseHelpers.ts b/packages/proxy/src/util/responseHelpers.ts
@@ -47,6 +47,10 @@ export function populateRatelimitErrorResponse(res: ServerResponse, error: RateL
 	res.setHeader('Retry-After', error.timeToReset / 1000);
 }
 
+/**
+ * Populates a server response with data relevant for a time out
+ * @param res The sever response to populate
+ */
 export function populateAbortErrorResponse(res: ServerResponse): void {
 	res.statusCode = 504;
 	res.statusMessage = 'Upstream timed out';