polarity-integration-utils
    Preparing search index...

    Type Alias HttpRequestResponse

    type HttpRequestResponse = {
        body: unknown;
        entities?: Entity[];
        entity?: Entity;
        error?: ApiRequestError | NetworkError | RetryRequestError;
        headers: unknown;
        request: {
            headers: unknown;
            method: string;
            uri: unknown;
            [key: string]: unknown;
        };
        requestId?: string
        | unknown;
        statusCode: number;
        [key: string]: unknown;
    }

    Indexable

    • [key: string]: unknown
    Index

    Properties

    body entities? entity? error? headers request requestId? statusCode

    Properties

    body

    body: unknown

    The body of the response.

    entities?: Entity[]

    An array of entities that the request was made for. The entities property matches the entities property set on the HttpRequestOptions object associated with this HttpRequestResponse.

    entity?: Entity

    The entity that the request was made for. The entity property matches the entity property set on the HttpRequestOptions object associated with this HttpRequestResponse.

    error?: ApiRequestError | NetworkError | RetryRequestError

    The error object if an error occurred during the request.

    headers: unknown

    The response headers

    request: {
        headers: unknown;
        method: string;
        uri: unknown;
        [key: string]: unknown;
    }
    requestId?: string | unknown

    A custom request id that can be used to identify the request. The requestId matches the requestId property set on the HttpRequestOptions object.

    statusCode: number

    The HTTP status code of the response.

    Settings

    Member Visibility

    On This Page

    Properties