Hosanna UI API v1.30.2-next
    Preparing search index...

    Interface IHsFetchResponse

    Interface representing a general-purpose HTTP response object. Used for handling responses in asynchronous operations.

    interface IHsFetchResponse {
        contextData?: JsonData;
        headers: Record<string, string>;
        ipAddress: string;
        json?: Record<string, any>;
        ok: boolean;
        response?: ISGROURLEvent;
        status: number;
        statusText: string;
        text?: string;
        transfer?: ISGROUrlTransfer;
    }
    Index

    Properties

    contextData? headers ipAddress json? ok response? status statusText text? transfer?

    Properties

    contextData?: JsonData

    Optional context data attached by HttpCommands when contextData is provided in fetch options. Use for any caller-defined context (e.g. row id, request key); post-process reads response.contextData.

    headers: Record<string, string>

    The headers of the response.

    ipAddress: string

    The IP address of the server that sent the response.

    json?: Record<string, any>

    The JSON body of the response, if applicable.

    ok: boolean

    Indicates whether the response was successful.

    response?: ISGROURLEvent

    The URL event associated with the response (available only in asyncManager worker tasks).

    status: number

    The HTTP status code of the response.

    statusText: string

    The HTTP status text of the response.

    Optionaltext

    text?: string

    The text body of the response, if applicable.

    transfer?: ISGROUrlTransfer

    The URL transfer object associated with the response (available only in asyncManager worker tasks).

    Settings

    Member Visibility

    On This Page

    Properties