fix warning in api report

Signed-off-by: Aramis Sennyey <aramiss@spotify.com>
This commit is contained in:
Aramis Sennyey
2023-11-17 14:56:09 -05:00
parent ea2e5f8e55
commit ffddac5a56
2 changed files with 14 additions and 7 deletions
+1 -3
View File
@@ -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<ErrorResponseBody>;
// @public (undocumented)
// @public
export function parseErrorResponseBody(
response: ConsumedResponse & {
text(): Promise<string>;
+13 -4
View File
@@ -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<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
@@ -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<ErrorResponseBody>;
export async function parseErrorResponseBody(
response: ConsumedResponse & { text(): Promise<string> },
): Promise<ErrorResponseBody>;