Class Fetcher

Hierarchy

Fetcher

Index

Constructors

Properties

#abortManager #config #interceptorManager

Accessors

abortManager baseUrl config interceptorManager

Methods

#executeRequest abort addInterceptor clearInterceptors clone createRequestId delete get patch post put removeInterceptor request updateConfig useBaseUrl withBaseUrl

Constructors

constructor

new Fetcher(config: FetcherConfig, interceptors?: FetcherInterceptor[]): Fetcher
Parameters
- config: FetcherConfig
- Optional interceptors: FetcherInterceptor[]
Returns Fetcher
- Defined in packages/fetcher/src/fetcher.ts:25

Properties

`Private` `Readonly` #abortManager

#abortManager: FetcherAbortManager

`Private` #config

#config: FetcherConfig

`Private` `Readonly` #interceptorManager

#interceptorManager: FetcherInterceptorManager

Accessors

abortManager

get abortManager(): FetcherAbortManager
Returns the FetcherAbortManager instance.

Returns FetcherAbortManager
- Defined in packages/fetcher/src/fetcher.ts:54

baseUrl

get baseUrl(): string
Base URL will be prepended to url unless url is absolute. It can be convenient to set baseURL for an instance of Fetcher to pass relative URLs to methods of that instance.

Returns string
- Defined in packages/fetcher/src/fetcher.ts:47

config

get config(): FetcherConfig
Returns FetcherConfig
- Defined in packages/fetcher/src/fetcher.ts:38

interceptorManager

get interceptorManager(): FetcherInterceptorManager
Returns the FetcherInterceptorManager instance.

Returns FetcherInterceptorManager
- Defined in packages/fetcher/src/fetcher.ts:61

Methods

`Private` #executeRequest

#executeRequest(id: string, request: FetcherRequest): Promise<Response>
Parameters
- id: string
- request: FetcherRequest
Returns Promise<Response>
- Defined in packages/fetcher/src/fetcher.ts:229

abort

abort(requestId?: string): boolean
Interrupts the request by given requestId, if request is not found returns false.
Parameters
- Optional requestId: string
Returns boolean
- Defined in packages/fetcher/src/fetcher.ts:119

addInterceptor

addInterceptor(interceptor: FetcherInterceptor): void
Sets new interceptor to the current instance.
Parameters
- interceptor: FetcherInterceptor
Returns void
- Defined in packages/fetcher/src/fetcher.ts:75

clearInterceptors

clearInterceptors(): void
Clears all existing interceptors from the current instance.

Returns void
- Defined in packages/fetcher/src/fetcher.ts:89

clone

clone(): Fetcher
Clones current Fetcher instance.

Returns Fetcher
- Defined in packages/fetcher/src/fetcher.ts:68

createRequestId

createRequestId(): string
Generates new request id in the UUID format.

Returns string
- Defined in packages/fetcher/src/fetcher.ts:126

delete

delete<T>(endpoint: string, opts?: FetcherRequestOpts): Promise<FetcherResponse<T>>
Makes a DELETE to a target endpoint with the provided body.
Type Parameters
- T
Parameters
- endpoint: string
- Optional opts: FetcherRequestOpts
Returns Promise<FetcherResponse<T>>
- Defined in packages/fetcher/src/fetcher.ts:218

get

get<T>(endpoint: string, opts?: FetcherRequestOpts): Promise<FetcherResponse<T>>
Makes a GET to a target endpoint with the provided query params.
Type Parameters
- T
Parameters
- endpoint: string
- Optional opts: FetcherRequestOpts
Returns Promise<FetcherResponse<T>>
- Defined in packages/fetcher/src/fetcher.ts:162

patch

patch<T>(endpoint: string, opts?: FetcherRequestOpts): Promise<FetcherResponse<T>>
Makes a PATCH to a target endpoint with the provided body.
Type Parameters
- T
Parameters
- endpoint: string
- Optional opts: FetcherRequestOpts
Returns Promise<FetcherResponse<T>>
- Defined in packages/fetcher/src/fetcher.ts:190

post

post<T>(endpoint: string, opts?: FetcherRequestOpts): Promise<FetcherResponse<T>>
Makes a POST to a target endpoint with the provided body.
Type Parameters
- T
Parameters
- endpoint: string
- Optional opts: FetcherRequestOpts
Returns Promise<FetcherResponse<T>>
- Defined in packages/fetcher/src/fetcher.ts:176

put

put<T>(endpoint: string, opts?: FetcherRequestOpts): Promise<FetcherResponse<T>>
Makes a PUT to a target endpoint with the provided body.
Type Parameters
- T
Parameters
- endpoint: string
- Optional opts: FetcherRequestOpts
Returns Promise<FetcherResponse<T>>
- Defined in packages/fetcher/src/fetcher.ts:204

removeInterceptor

removeInterceptor(interceptor: FetcherInterceptor): void
Removes the existing interceptor from the current instance.
Parameters
- interceptor: FetcherInterceptor
Returns void
- Defined in packages/fetcher/src/fetcher.ts:82

request

request<T>(cfg: FetcherRequestConfig): Promise<FetcherResponse<T>>
Performs a http request.
Type Parameters
- T = unknown
Parameters
- cfg: FetcherRequestConfig
Returns Promise<FetcherResponse<T>>
- Defined in packages/fetcher/src/fetcher.ts:133

updateConfig

updateConfig(config: Partial<FetcherConfig>): void
Parameters
- config: Partial<FetcherConfig>
Returns void
- Defined in packages/fetcher/src/fetcher.ts:109

useBaseUrl

useBaseUrl(baseUrl: string): Fetcher
Assigns new base URL to the current instance.
Parameters
- baseUrl: string
Returns Fetcher
- Defined in packages/fetcher/src/fetcher.ts:96

withBaseUrl

withBaseUrl(baseUrl: string): Fetcher
Creates new instance Fetcher instance with given base URL.
Parameters
- baseUrl: string
Returns Fetcher
- Defined in packages/fetcher/src/fetcher.ts:105

Generated using TypeDoc