Class FetchRest

Fetch Rest - main class. RECOMMENDATION: It is generally recommended to use FetchRestSingleton controls instead of FetchRest.

Hierarchy (View Summary)

FetchRest
- FetchRestSingleton

Index

Constructors

constructor

new FetchRest(__namedParameters: FROptions): FetchRest
Parameters
- __namedParameters: FROptions
Returns FetchRest
- Defined in src/index.ts:160

Properties

`Protected`baseUrl

baseUrl: string

`Protected` `Optional`fetchFn

fetchFn?: (
input: string | URL | Request,
init?: RequestInit,
) => Promise<Response>

`Protected` `Optional`fetchOpts

fetchOpts?: RequestInit

`Protected`handle401

handle401: null | FRAuthFailureHandler = null

`Protected`hooks

hooks: { afterRequest?: FRHook; beforeRequest?: FRHook }

`Protected`jwtToken

jwtToken: null | string = null

`Protected`logs

logs: boolean

`Protected`pendingRequests

pendingRequests: Map<string, { promise: Promise<unknown>; timestamp: number }> = ...

`Protected`retryCount

retryCount: number

`Protected`retryDelayMs

retryDelayMs: number

`Protected`retryOn

retryOn: number[]

`Protected` `Static`ongoing401Handler

ongoing401Handler: null | Promise<void> = null

Methods

`Protected`buildHeaders

buildHeaders(
opts?: FRRequestOptions<unknown> & { method?: FRHttpMethod },
): { [k: string]: string }
Parameters
- Optionalopts: FRRequestOptions<unknown> & { method?: FRHttpMethod }
Returns { [k: string]: string }
- Defined in src/index.ts:379

`Protected`buildRequestKey

buildRequestKey(url: string, method: string, body?: unknown): string
Parameters
- url: string
- method: string
- Optionalbody: unknown
Returns string
- Defined in src/index.ts:371

`Protected`buildUrl

buildUrl(
    path: string,
    params?: Record<string, string | number>,
    query?: Record<
        string,
        undefined
        | string
        | number
        | boolean
        | string[]
        | number[],
    >,
): string
Parameters
- path: string
- Optionalparams: Record<string, string | number>
- Optionalquery: Record<string, undefined | string | number | boolean | string[] | number[]>
Returns string
- Defined in src/index.ts:400

delete

delete<TResponse = unknown>(
path: string,
options?: Omit<FRRequestOptions<unknown>, "body">,
): Promise<TResponse>
Type Parameters
- TResponse = unknown
Parameters
- path: string
- Optionaloptions: Omit<FRRequestOptions<unknown>, "body">
Returns Promise<TResponse>
- Defined in src/index.ts:213

get

get<TResponse = unknown>(
path: string,
options?: Omit<FRRequestOptions<unknown>, "body">,
): Promise<TResponse>
Type Parameters
- TResponse = unknown
Parameters
- path: string
- Optionaloptions: Omit<FRRequestOptions<unknown>, "body">
Returns Promise<TResponse>
- Defined in src/index.ts:193

head

head<TResponse = unknown>(
path: string,
options?: Omit<FRRequestOptions<unknown>, "body">,
): Promise<TResponse>
Type Parameters
- TResponse = unknown
Parameters
- path: string
- Optionaloptions: Omit<FRRequestOptions<unknown>, "body">
Returns Promise<TResponse>
- Defined in src/index.ts:188

`Protected`log

log(...args: unknown[]): void
Parameters
- ...args: unknown[]
Returns void
- Defined in src/index.ts:218

patch

patch<TResponse = unknown, TBody = unknown>(
path: string,
options?: FRRequestOptions<TBody>,
): Promise<TResponse>
Type Parameters
- TResponse = unknown
- TBody = unknown
Parameters
- path: string
- Optionaloptions: FRRequestOptions<TBody>
Returns Promise<TResponse>
- Defined in src/index.ts:208

post

post<TResponse = unknown, TBody = unknown>(
path: string,
options?: FRRequestOptions<TBody>,
): Promise<TResponse>
Type Parameters
- TResponse = unknown
- TBody = unknown
Parameters
- path: string
- Optionaloptions: FRRequestOptions<TBody>
Returns Promise<TResponse>
- Defined in src/index.ts:198

put

put<TResponse = unknown, TBody = unknown>(
path: string,
options?: FRRequestOptions<TBody>,
): Promise<TResponse>
Type Parameters
- TResponse = unknown
- TBody = unknown
Parameters
- path: string
- Optionaloptions: FRRequestOptions<TBody>
Returns Promise<TResponse>
- Defined in src/index.ts:203

request

request<TResponse = unknown, TBody = unknown>(
path: string,
options?: FRRequestOptions<TBody> & { method?: FRHttpMethod },
): Promise<TResponse>
Type Parameters
- TResponse = unknown
- TBody = unknown
Parameters
- path: string
- options: FRRequestOptions<TBody> & { method?: FRHttpMethod } = {}
Returns Promise<TResponse>
- Defined in src/index.ts:222

set401Handler

set401Handler(handler: FRAuthFailureHandler): void
Parameters
- handler: FRAuthFailureHandler
Returns void
- Defined in src/index.ts:184

setJwtToken

setJwtToken(token: string): void
Parameters
- token: string
Returns void
- Defined in src/index.ts:180

`Protected`sleep

sleep(ms: number): Promise<void>
Parameters
- ms: number
Returns Promise<void>
- Defined in src/index.ts:441

Class FetchRest

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FetchRest

Properties

ProtectedbaseUrl

Protected OptionalfetchFn

Protected OptionalfetchOpts

Protectedhandle401

Protectedhooks

ProtectedjwtToken

Protectedlogs

ProtectedpendingRequests

ProtectedretryCount

ProtectedretryDelayMs

ProtectedretryOn

Protected Staticongoing401Handler

Methods

ProtectedbuildHeaders

Parameters

Returns { [k: string]: string }

ProtectedbuildRequestKey

Parameters

Returns string

ProtectedbuildUrl

Parameters

Returns string

delete

Type Parameters

Parameters

Returns Promise<TResponse>

get

Type Parameters

Parameters

Returns Promise<TResponse>

head

Type Parameters

Parameters

Returns Promise<TResponse>

Protectedlog

Parameters

Returns void

patch

Type Parameters

Parameters

Returns Promise<TResponse>

post

Type Parameters

Parameters

Returns Promise<TResponse>

put

Type Parameters

Parameters

Returns Promise<TResponse>

request

Type Parameters

Parameters

Returns Promise<TResponse>

set401Handler

Parameters

Returns void

setJwtToken

Parameters

Returns void

Protectedsleep

Parameters

Returns Promise<void>

Settings

On This Page

`Protected`baseUrl

`Protected` `Optional`fetchFn

`Protected` `Optional`fetchOpts

`Protected`handle401

`Protected`hooks

`Protected`jwtToken

`Protected`logs

`Protected`pendingRequests

`Protected`retryCount

`Protected`retryDelayMs

`Protected`retryOn

`Protected` `Static`ongoing401Handler

`Protected`buildHeaders

`Protected`buildRequestKey

`Protected`buildUrl

`Protected`log

`Protected`sleep