Class ZHttpRequestBuilder<TBody>

constructor

• new ZHttpRequestBuilder<TBody = any>(): ZHttpRequestBuilder<TBody>

  Initializes a new instance of this object.

  Type Parameters

  • TBody = any

  Returns ZHttpRequestBuilder<TBody>

json

build

• build(): IZHttpRequest

  Returns the constructed request.

  Returns IZHttpRequest

  The constructed request.

content

• content(type: string): ZHttpRequestBuilder<TBody>

  Sets the content type header.

  Parameters

  • type: string

    The content mime type.

  Returns ZHttpRequestBuilder<TBody>

  This object.

copy

• copy(other: IZHttpRequest): this

  Copies other to this object.

  Parameters

  • other: IZHttpRequest

    The request to copy.

  Returns this

  This object.

delete

• delete(): ZHttpRequestBuilder<TBody>

  Constructs a delete request.

  Returns ZHttpRequestBuilder<TBody>

  This object.

get

• get(): ZHttpRequestBuilder<TBody>

  Constructs a get request.

  Returns ZHttpRequestBuilder<TBody>

  This object.

head

• head(): ZHttpRequestBuilder<TBody>

  Constructs a head request.

  Returns ZHttpRequestBuilder<TBody>

  This object.

header

• header(key: string, value: string | number | boolean | null): this

  Sets an individual header.

  Parameters

  • key: string

    The header key to set.

  • value: string | number | boolean | null

    The value to set.

  Returns this

  This object.

headers

• headers(headers: Record<string, string>): this

  Sets the headers.

  Parameters

  • headers: Record<string, string>

    The headers to set.

  Returns this

  This object.

options

• options(): ZHttpRequestBuilder<TBody>

  Constructs a options request.

  Returns ZHttpRequestBuilder<TBody>

  This object.

patch

• patch(body?: TBody): ZHttpRequestBuilder<TBody>

  Constructs a patch request.

  Parameters

  • Optionalbody: TBody

  Returns ZHttpRequestBuilder<TBody>

  This object.

post

• post(body?: TBody): ZHttpRequestBuilder<TBody>

  Constructs a post request.

  Parameters

  • Optionalbody: TBody

  Returns ZHttpRequestBuilder<TBody>

  This object.

put

• put(body?: TBody): ZHttpRequestBuilder<TBody>

  Constructs a put request.

  Parameters

  • Optionalbody: TBody

  Returns ZHttpRequestBuilder<TBody>

  This object.

timeout

• timeout(ms: number): this

  Sets the timeout for the url.

  Parameters

  • ms: number

    The total number of milliseconds to wait.

  Returns this

  The object.

url

• url(url: string): this

  Sets the url to make the request from.

  Parameters

  • url: string

    The url to make the request to.

  Returns this

  This object.

Staticduplicate

• duplicate<TBody>(other: IZHttpRequest<TBody>): IZHttpRequest<TBody>

  Duplicates a request, keeping it's structure intact.

  The underlying headers will be duplicated, but everything else will be a shallow copy to preserve the body in the case that it is a blob or other binary structure.

  Type Parameters

  • TBody

  Parameters

  • other: IZHttpRequest<TBody>

    The request to duplicate.

  Returns IZHttpRequest<TBody>

  The duplicated object.