Class ZHttpRequestBuilder<TBody>

Represents a builder for an http request.

Type Parameters

TBody = any

Index

Constructors

Properties

Methods

build content copy delete get head header headers options patch post put timeout url duplicate

Constructors

constructor

new ZHttpRequestBuilder<TBody = any>(): ZHttpRequestBuilder<TBody>
Initializes a new instance of this object.
Type Parameters
- TBody = any
Returns ZHttpRequestBuilder<TBody>
- Defined in request/http-request.mts:121

Properties

json

json: (...args: []) => ZHttpRequestBuilder = ...

Sets the content type to json.

Type Declaration

- (...args: []): ZHttpRequestBuilder
- Parameters
  - ...args: []
  Returns ZHttpRequestBuilder
  This object.

Methods

build

build(): IZHttpRequest
Returns the constructed request.

Returns IZHttpRequest
The constructed request.
- Defined in request/http-request.mts:326

content

content(type: string): ZHttpRequestBuilder<TBody>
Sets the content type header.
Parameters
- type: string
  The content mime type.
Returns ZHttpRequestBuilder<TBody>
This object.
- Defined in request/http-request.mts:294

copy

copy(other: IZHttpRequest): this
Copies other to this object.
Parameters
- other: IZHttpRequest
  The request to copy.
Returns this
This object.
- Defined in request/http-request.mts:315

delete

delete(): ZHttpRequestBuilder<TBody>
Constructs a delete request.

Returns ZHttpRequestBuilder<TBody>
This object.
- Defined in request/http-request.mts:186

get

get(): ZHttpRequestBuilder<TBody>
Constructs a get request.

Returns ZHttpRequestBuilder<TBody>
This object.
- Defined in request/http-request.mts:156

head

head(): ZHttpRequestBuilder<TBody>
Constructs a head request.

Returns ZHttpRequestBuilder<TBody>
This object.
- Defined in request/http-request.mts:216

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.
- Defined in request/http-request.mts:273

headers

headers(headers: Record<string, string>): this
Sets the headers.
Parameters
- headers: Record<string, string>
  The headers to set.
Returns this
This object.
- Defined in request/http-request.mts:257

options

options(): ZHttpRequestBuilder<TBody>
Constructs a options request.

Returns ZHttpRequestBuilder<TBody>
This object.
- Defined in request/http-request.mts:206

patch

patch(body?: TBody): ZHttpRequestBuilder<TBody>
Constructs a patch request.
Parameters
- Optionalbody: TBody
Returns ZHttpRequestBuilder<TBody>
This object.
- Defined in request/http-request.mts:196

post

post(body?: TBody): ZHttpRequestBuilder<TBody>
Constructs a post request.
Parameters
- Optionalbody: TBody
Returns ZHttpRequestBuilder<TBody>
This object.
- Defined in request/http-request.mts:166

put

put(body?: TBody): ZHttpRequestBuilder<TBody>
Constructs a put request.
Parameters
- Optionalbody: TBody
Returns ZHttpRequestBuilder<TBody>
This object.
- Defined in request/http-request.mts:176

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.
- Defined in request/http-request.mts:243

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.
- Defined in request/http-request.mts:229

`Static`duplicate

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.
- Defined in request/http-request.mts:112