Stone.js API
    Preparing search index...

    Class ServerResponseWrapper

    A wrapper for the GCP Cloud Functions HTTP ServerResponse to implement the IRawResponseWrapper interface.

    This class provides methods for configuring and sending HTTP responses in a consistent and flexible manner. It supports setting status codes, headers, streaming files, or sending raw body content.

    Implements

    • IRawResponseWrapper<ServerResponse>
    Index
    options response
    respond create
    options: Partial<RawHttpResponseOptions> = {}

    Partial configuration for customizing the response.

    response: ServerResponse

    The Node.js ServerResponse object to be wrapped.

    • Sends the HTTP response based on the configured options.

      This method:

      • Sets the statusCode and statusMessage if provided.
      • Configures response headers if specified.
      • Streams a file if streamFile is defined.
      • Sends raw content if body is provided.

      Returns Promise<ServerResponse<IncomingMessage>>

      A promise that resolves to the HTTP status code of the response.

      An error if the response cannot be sent due to an issue in streamFile.

    Settings
    Member Visibility

    On This Page
    Properties
    Methods