Class RequestModel

Represents a model for HTTP requests. This class encapsulates all necessary details such as URL, method, path, query parameters, body, headers, scheme, port, and timeout settings.

Constructors

constructor

Methods

getBody getHeaders getMethod getOptions getPath getPort getQuery getScheme getTimeout getUrl setBody setHeaders setMethod setPath setPort setQuery setScheme setTimeout setUrl

Constructors

constructor

  • new RequestModel(url, method?, path, query, body, headers, scheme?, port): RequestModel

  • Constructs an instance of the RequestModel.

    Parameters

    • url: string

      The base URL of the HTTP request.

    • method: string = 'GET'

      HTTP method, default is 'GET'.

    • path: string

      URL path.

    • query: Record<string, dynamic>

      Query parameters as a record of key-value pairs.

    • body: Record<string, dynamic>

      Body of the request as a record of key-value pairs.

    • headers: Record<string, string>

      HTTP headers as a record of key-value pairs.

    • scheme: string = HTTP

      Protocol scheme, default is 'http'.

    • port: number

      Port number, default is 80.

    Returns RequestModel

Properties

Private body

body: Record<string, dynamic>

Private headers

headers: Record<string, string>

Private method

method: string

Private path

path: string

Private port

port: number

Private query

query: Record<string, dynamic>

Private scheme

scheme: string

Private timeout

timeout: number

Private url

url: string

Methods

getBody

getHeaders

getMethod

getOptions

  • getOptions(): Record<string, any>

  • Constructs the options for the HTTP request based on the current state of the model. This method is used to prepare the request options for execution.

    Returns Record<string, any>

    A record containing all relevant options for the HTTP request.

getPath

getPort

getQuery

getScheme

getTimeout

getUrl

setBody

setHeaders

setMethod

setPath

setPort

setQuery

setScheme

setTimeout

setUrl

Settings

Member Visibility

Theme

On This Page

constructorbodyheadersmethodpathportqueryschemetimeouturlgetBodygetHeadersgetMethodgetOptionsgetPathgetPortgetQuerygetSchemegetTimeoutgetUrlsetBodysetHeaderssetMethodsetPathsetPortsetQuerysetSchemesetTimeoutsetUrl