1

http

ztimson edited this page 2024-09-22 03:11:09 -04:00

Table of Contents

• http
• Classes
• Http
• Constructors
• new Http()
• Parameters
• Returns
• Defined in
• Properties
• headers
• Index Signature
• Defined in
• url
• Defined in
• headers
• Index Signature
• Defined in
• Methods
• addInterceptor()
• Parameters
• Returns
• Returns
• Defined in
• request()
• Type Parameters
• Parameters
• Returns
• Defined in
• addInterceptor()
• Parameters
• Returns
• Returns
• Defined in
• Type Aliases
• DecodedResponse<T>
• Type declaration
• data
• Type Parameters
• Defined in
• HttpDefaults
• Type declaration
• headers?
• Index Signature
• interceptors?
• url?
• Defined in
• HttpInterceptor()
• Parameters
• Returns
• Defined in
• HttpRequestOptions
• Index Signature
• Type declaration
• body?
• decode?
• fragment?
• headers?
• Index Signature
• method?
• query?
• url?
• Defined in

@ztimson/utils / http

http

Classes

Http

Constructors

new Http()

new Http(defaults): Http

Parameters

• defaults: HttpDefaults = {}

Returns

Http

Defined in

src/http.ts:35

Properties

headers

headers: object = {}

Index Signature

[key: string]: string | null | undefined

Defined in

src/http.ts:32

url

url: null | string

Defined in

src/http.ts:33

headers

static headers: object = {}

Index Signature

[key: string]: string | null | undefined

Defined in

src/http.ts:28

Methods

addInterceptor()

addInterceptor(fn): () => void

Parameters

• fn: HttpInterceptor

Returns

Function

Returns

void

Defined in

src/http.ts:49

request()

request<T>(opts): PromiseProgress<DecodedResponse<T>>

Type Parameters

• T

Parameters

• opts: HttpRequestOptions = {}

Returns

PromiseProgress<DecodedResponse<T>>

Defined in

src/http.ts:55

addInterceptor()

static addInterceptor(fn): () => void

Parameters

• fn: HttpInterceptor

Returns

Function

Returns

void

Defined in

src/http.ts:43

Type Aliases

DecodedResponse<T>

DecodedResponse<T>: Response & object

Type declaration

data

data: T | null

Type Parameters

• T

Defined in

src/http.ts:4

---

HttpDefaults

HttpDefaults: object

Type declaration

headers?

optional headers: object

Index Signature

[key: string | symbol]: string | null | undefined

interceptors?

optional interceptors: HttpInterceptor[]

url?

optional url: string

Defined in

src/http.ts:19

---

HttpInterceptor()

HttpInterceptor: (response, next) => void

Parameters

• response: Response

• next

Returns

void

Defined in

src/http.ts:6

---

HttpRequestOptions

HttpRequestOptions: object

Index Signature

[key: string]: any

Type declaration

body?

optional body: any

decode?

optional decode: boolean

fragment?

optional fragment: string

headers?

optional headers: object

Index Signature

[key: string | symbol]: string | null | undefined

method?

optional method: "GET" | "POST" | "PATCH" | "PUT" | "DELETE"

query?

optional query: object[] | object

url?

optional url: string

Defined in

src/http.ts:8