Saltar al contenido principal

Interface: IFetchApiManager

Defined in: src/types/index.ts:269

Contract of the fetch facade.

Methods​

useBuildApiUrl()​

useBuildApiUrl(apiName, endpointName, options?): string

Defined in: src/types/index.ts:275

Parameters​

apiName​

string

endpointName​

string

options?​

UrlOptions

Returns​

string

useBuildUrl()​

useBuildUrl(apiName, endpointName, options?): string

Defined in: src/types/index.ts:274

Parameters​

apiName​

string

endpointName​

string

options?​

UrlOptions

Returns​

string

useDelete()​

useDelete<T>(apiName, endpointName, urlOptions?): Promise<FetchResult<T>>

Defined in: src/types/index.ts:314

Type Parameters​

T​

T = unknown

Parameters​

apiName​

string

endpointName​

string

urlOptions?​

UrlOptions

Returns​

Promise<FetchResult<T>>

useFetch()​

useFetch<T>(apiName, endpointName, options?): Promise<FetchResult<T>>

Defined in: src/types/index.ts:276

Type Parameters​

T​

T = unknown

Parameters​

apiName​

string

endpointName​

string

options?​

FetchOptions

Returns​

Promise<FetchResult<T>>

useFetchApi()​

useFetchApi<T>(apiName, endpointName, options?): Promise<FetchResult<T>>

Defined in: src/types/index.ts:281

Type Parameters​

T​

T = unknown

Parameters​

apiName​

string

endpointName​

string

options?​

FetchOptions

Returns​

Promise<FetchResult<T>>

useGet()​

useGet<T>(apiName, endpointName, urlOptions?): Promise<FetchResult<T>>

Defined in: src/types/index.ts:286

Type Parameters​

T​

T = unknown

Parameters​

apiName​

string

endpointName​

string

urlOptions?​

UrlOptions

Returns​

Promise<FetchResult<T>>

useGetApi()​

useGetApi<T>(apiName, endpointName, urlOptions?): Promise<FetchResult<T>>

Defined in: src/types/index.ts:291

Type Parameters​

T​

T = unknown

Parameters​

apiName​

string

endpointName​

string

urlOptions?​

UrlOptions

Returns​

Promise<FetchResult<T>>

useGetApis()​

useGetApis(): ApisConfig

Defined in: src/types/index.ts:272

Returns​

ApisConfig

useGetApisConfig()​

useGetApisConfig(): ApisConfig

Defined in: src/types/index.ts:273

Returns​

ApisConfig

useInit()​

useInit(apis): void

Defined in: src/types/index.ts:270

Parameters​

apis​

ApisConfig

Returns​

void

useInitApis()​

useInitApis(apis): void

Defined in: src/types/index.ts:271

Parameters​

apis​

ApisConfig

Returns​

void

usePatch()​

usePatch<T>(apiName, endpointName, body?, urlOptions?): Promise<FetchResult<T>>

Defined in: src/types/index.ts:308

Type Parameters​

T​

T = unknown

Parameters​

apiName​

string

endpointName​

string

body?​

unknown

urlOptions?​

UrlOptions

Returns​

Promise<FetchResult<T>>

usePost()​

usePost<T>(apiName, endpointName, body?, urlOptions?): Promise<FetchResult<T>>

Defined in: src/types/index.ts:296

Type Parameters​

T​

T = unknown

Parameters​

apiName​

string

endpointName​

string

body?​

unknown

urlOptions?​

UrlOptions

Returns​

Promise<FetchResult<T>>

usePut()​

usePut<T>(apiName, endpointName, body?, urlOptions?): Promise<FetchResult<T>>

Defined in: src/types/index.ts:302

Type Parameters​

T​

T = unknown

Parameters​

apiName​

string

endpointName​

string

body?​

unknown

urlOptions?​

UrlOptions

Returns​

Promise<FetchResult<T>>