From ffddac5a5669ae024beb611c751c2446ed1b9f3a Mon Sep 17 00:00:00 2001 From: Aramis Sennyey Date: Fri, 17 Nov 2023 14:56:09 -0500 Subject: [PATCH] fix warning in api report Signed-off-by: Aramis Sennyey --- packages/errors/api-report.md | 4 +--- packages/errors/src/serialization/response.ts | 17 +++++++++++++---- 2 files changed, 14 insertions(+), 7 deletions(-) diff --git a/packages/errors/api-report.md b/packages/errors/api-report.md index b62e7a2053..42da6e28a6 100644 --- a/packages/errors/api-report.md +++ b/packages/errors/api-report.md @@ -112,15 +112,13 @@ export class NotModifiedError extends CustomErrorBase { name: 'NotModifiedError'; } -// Warning: (ae-missing-release-tag) "parseErrorResponseBody" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public export function parseErrorResponseBody( response: ConsumedResponse, rawBody: string, ): Promise; -// @public (undocumented) +// @public export function parseErrorResponseBody( response: ConsumedResponse & { text(): Promise; diff --git a/packages/errors/src/serialization/response.ts b/packages/errors/src/serialization/response.ts index b956830278..c7d45465db 100644 --- a/packages/errors/src/serialization/response.ts +++ b/packages/errors/src/serialization/response.ts @@ -41,6 +41,19 @@ export type ErrorResponseBody = { }; }; +/** + * Attempts to construct an ErrorResponseBody out of a failed server request. + * Assumes that the response has already been checked to be not ok. This function + * expects that rawBody is the body of the response and will not attempt to + * parse the body from the response again. + * + * @public + * @param response - The response of a failed request + */ +export async function parseErrorResponseBody( + response: ConsumedResponse, + rawBody: string, +): Promise; /** * Attempts to construct an ErrorResponseBody out of a failed server request. * Assumes that the response has already been checked to be not ok. This @@ -53,10 +66,6 @@ export type ErrorResponseBody = { * @public * @param response - The response of a failed request */ -export async function parseErrorResponseBody( - response: ConsumedResponse, - rawBody: string, -): Promise; export async function parseErrorResponseBody( response: ConsumedResponse & { text(): Promise }, ): Promise;