Class HttpRequestBuilder<D>

A builder for constructing HttpRequest instances.

Type Parameters

D

Hierarchy

HttpRequestBuilder

Implements

HttpRequest<D>

Index

Constructors

Properties

Accessors

data headers maxRedirects method signal timeout url

Constructors

constructor

new HttpRequestBuilder<D>(request: HttpRequest<D>): HttpRequestBuilder<D>
Type Parameters
- D
Parameters
- request: HttpRequest<D>
Returns HttpRequestBuilder<D>
- Defined in packages/umi/src/HttpRequest.ts:40

Properties

`Protected` `Readonly` request

request: HttpRequest<D>

Accessors

data

get data(): D
Returns D
Implementation of HttpRequest.data
- Defined in packages/umi/src/HttpRequest.ts:152

headers

get headers(): HttpRequestHeaders
Returns HttpRequestHeaders
Implementation of HttpRequest.headers
- Defined in packages/umi/src/HttpRequest.ts:156

maxRedirects

get maxRedirects(): undefined | number
Returns undefined | number
Implementation of HttpRequest.maxRedirects
- Defined in packages/umi/src/HttpRequest.ts:160

method

get method(): HttpMethod
Returns HttpMethod
Implementation of HttpRequest.method
- Defined in packages/umi/src/HttpRequest.ts:144

signal

get signal(): undefined | GenericAbortSignal
Returns undefined | GenericAbortSignal
Implementation of HttpRequest.signal
- Defined in packages/umi/src/HttpRequest.ts:168

timeout

get timeout(): undefined | number
Returns undefined | number
Implementation of HttpRequest.timeout
- Defined in packages/umi/src/HttpRequest.ts:164

url

get url(): string
Returns string
Implementation of HttpRequest.url
- Defined in packages/umi/src/HttpRequest.ts:148

Methods

accept

accept(contentType: string): HttpRequestBuilder<D>
Parameters
- contentType: string
Returns HttpRequestBuilder<D>
- Defined in packages/umi/src/HttpRequest.ts:56

asForm

asForm(): HttpRequestBuilder<D>
Returns HttpRequestBuilder<D>
- Defined in packages/umi/src/HttpRequest.ts:52

asJson

asJson(): HttpRequestBuilder<D>
Returns HttpRequestBuilder<D>
- Defined in packages/umi/src/HttpRequest.ts:44

asMultipart

asMultipart(): HttpRequestBuilder<D>
Returns HttpRequestBuilder<D>
- Defined in packages/umi/src/HttpRequest.ts:48

contentType

contentType(contentType: string): HttpRequestBuilder<D>
Parameters
- contentType: string
Returns HttpRequestBuilder<D>
- Defined in packages/umi/src/HttpRequest.ts:60

delete

delete(url: string): HttpRequestBuilder<D>
Parameters
- url: string
Returns HttpRequestBuilder<D>
- Defined in packages/umi/src/HttpRequest.ts:140

dontFollowRedirects

dontFollowRedirects(): HttpRequestBuilder<D>
Returns HttpRequestBuilder<D>
- Defined in packages/umi/src/HttpRequest.ts:83

followRedirects

followRedirects(maxRedirects?: number): HttpRequestBuilder<D>
Parameters
- Optional maxRedirects: number
Returns HttpRequestBuilder<D>
- Defined in packages/umi/src/HttpRequest.ts:87

get

get(url: string): HttpRequestBuilder<D>
Parameters
- url: string
Returns HttpRequestBuilder<D>
- Defined in packages/umi/src/HttpRequest.ts:124

patch

patch(url: string): HttpRequestBuilder<D>
Parameters
- url: string
Returns HttpRequestBuilder<D>
- Defined in packages/umi/src/HttpRequest.ts:136

post

post(url: string): HttpRequestBuilder<D>
Parameters
- url: string
Returns HttpRequestBuilder<D>
- Defined in packages/umi/src/HttpRequest.ts:128

put

put(url: string): HttpRequestBuilder<D>
Parameters
- url: string
Returns HttpRequestBuilder<D>
- Defined in packages/umi/src/HttpRequest.ts:132

userAgent

userAgent(userAgent: string): HttpRequestBuilder<D>
Parameters
- userAgent: string
Returns HttpRequestBuilder<D>
- Defined in packages/umi/src/HttpRequest.ts:64

withAbortSignal

withAbortSignal(signal?: GenericAbortSignal): HttpRequestBuilder<D>
Parameters
- Optional signal: GenericAbortSignal
Returns HttpRequestBuilder<D>
- Defined in packages/umi/src/HttpRequest.ts:99

withData

withData<T>(data: T): HttpRequestBuilder<T>
Type Parameters
- T
Parameters
- data: T
Returns HttpRequestBuilder<T>
- Defined in packages/umi/src/HttpRequest.ts:120

withEndpoint

withEndpoint(method: HttpMethod, url: string): HttpRequestBuilder<D>
Parameters
- method: HttpMethod
- url: string
Returns HttpRequestBuilder<D>
- Defined in packages/umi/src/HttpRequest.ts:103

withHeader

withHeader(key: string, value: HttpHeaderValue): HttpRequestBuilder<D>
Parameters
- key: string
- value: HttpHeaderValue
Returns HttpRequestBuilder<D>
- Defined in packages/umi/src/HttpRequest.ts:72

withHeaders

withHeaders(headers: HttpRequestHeaders): HttpRequestBuilder<D>
Parameters
- headers: HttpRequestHeaders
Returns HttpRequestBuilder<D>
- Defined in packages/umi/src/HttpRequest.ts:76

withParams

withParams(params: string | URLSearchParams | Record<string, string> | string[][]): HttpRequestBuilder<D>
Parameters
- params: string | URLSearchParams | Record<string, string> | string[][]
Returns HttpRequestBuilder<D>
- Defined in packages/umi/src/HttpRequest.ts:107

withTimeout

withTimeout(timeout?: number): HttpRequestBuilder<D>
Parameters
- Optional timeout: number
Returns HttpRequestBuilder<D>
- Defined in packages/umi/src/HttpRequest.ts:95

withToken

withToken(token: string, type?: string): HttpRequestBuilder<D>
Parameters
- token: string
- type: string = 'Bearer'
Returns HttpRequestBuilder<D>
- Defined in packages/umi/src/HttpRequest.ts:68

withoutTimeout

withoutTimeout(): HttpRequestBuilder<D>
Returns HttpRequestBuilder<D>
- Defined in packages/umi/src/HttpRequest.ts:91

Generated using TypeDoc