Class ReqFetch

Hierarchy (View Summary)

ReqBase
- ReqFetch

Index

Constructors

constructor

new ReqFetch(
    cookie?:
        | string
        | Omit<ReqConfig, "reqOptions"> & { reqOptions?: ReqOptions },
    headers?: OutgoingHttpHeaders,
): ReqFetch
Parameters
- Optionalcookie: string | Omit<ReqConfig, "reqOptions"> & { reqOptions?: ReqOptions }
- Optionalheaders: OutgoingHttpHeaders
Returns ReqFetch
Overrides ReqBase.constructor
- Defined in src/common/lib/ReqFetch.ts:116

Properties

`Protected`config

config: ReqConfig = {}

`Protected`headers

headers: OutgoingHttpHeaders = ...

`Protected`isBrowser

isBrowser: boolean = ...

`Static`instance

instance: ReqFetch

Methods

`Protected`formatUrl

formatUrl(url: string | URL): URL
Parameters
- url: string | URL
Returns URL
Inherited from ReqBase.formatUrl
- Defined in src/common/lib/ReqFetch.ts:63

get

get<T = AnyObject>(
    url: string,
    parameters?: AnyObject,
    headers?: OutgoingHttpHeaders,
    options?: ReqOptions,
): Promise<{ buffer: ArrayBuffer; data: T; response: Response }>
Type Parameters
- T = AnyObject
Parameters
- url: string
- Optionalparameters: AnyObject
- Optionalheaders: OutgoingHttpHeaders
- Optionaloptions: ReqOptions
Returns Promise<{ buffer: ArrayBuffer; data: T; response: Response }>
- Defined in src/common/lib/ReqFetch.ts:152

getConfig

getConfig(): {
    baseURL?: string;
    cookie?: string;
    headers?: OutgoingHttpHeaders;
    reqOptions?: ReqOptions
    | RequestOptions;
}
Returns {
    baseURL?: string;
    cookie?: string;
    headers?: OutgoingHttpHeaders;
    reqOptions?: ReqOptions | RequestOptions;
}
Inherited from ReqBase.getConfig
- Defined in src/common/lib/ReqFetch.ts:73

getCookie

getCookie(isString?: true): string
Parameters
- OptionalisString: true
Returns string
Inherited from ReqBase.getCookie
- Defined in src/common/lib/ReqFetch.ts:102
getCookie(isString: false): Record<string, string>
Parameters
- isString: false
Returns Record<string, string>
Inherited from ReqBase.getCookie
- Defined in src/common/lib/ReqFetch.ts:103

getHeaders

getHeaders(urlObject?: URL, headers?: OutgoingHttpHeaders): OutgoingHttpHeaders
Parameters
- OptionalurlObject: URL
- Optionalheaders: OutgoingHttpHeaders
Returns OutgoingHttpHeaders
Inherited from ReqBase.getHeaders
- Defined in src/common/lib/ReqFetch.ts:84

post

post<T = AnyObject>(
    url: string,
    parameters: AnyObject,
    headers?: OutgoingHttpHeaders,
    options?: ReqOptions,
): Promise<{ buffer: ArrayBuffer; data: T; response: Response }>
Type Parameters
- T = AnyObject
Parameters
- url: string
- parameters: AnyObject
- Optionalheaders: OutgoingHttpHeaders
- Optionaloptions: ReqOptions
Returns Promise<{ buffer: ArrayBuffer; data: T; response: Response }>
- Defined in src/common/lib/ReqFetch.ts:155

req

req(
    url: string | URL,
    parameters?: AnyObject,
    options?: ReqOptions,
    autoRedirect?: boolean,
): Promise<Response>
Parameters
- url: string | URL
- Optionalparameters: AnyObject
- options: ReqOptions = {}
- autoRedirect: boolean = true
Returns Promise<Response>
- Defined in src/common/lib/ReqFetch.ts:119

request

request<T = AnyObject>(
    method: string,
    url: string | URL,
    parameters?: AnyObject,
    options?: ReqOptions,
): Promise<{ buffer: ArrayBuffer; data: T; response: Response }>
Type Parameters
- T = AnyObject
Parameters
- method: string
- url: string | URL
- Optionalparameters: AnyObject
- Optionaloptions: ReqOptions
Returns Promise<{ buffer: ArrayBuffer; data: T; response: Response }>
- Defined in src/common/lib/ReqFetch.ts:140

setConfig

setConfig(cfg: ReqConfig): void
Parameters
- cfg: ReqConfig
Returns void
Inherited from ReqBase.setConfig
- Defined in src/common/lib/ReqFetch.ts:76

setHeaders

setHeaders(headers: OutgoingHttpHeaders, type?: "merge" | "reset"): ReqFetch
Parameters
- headers: OutgoingHttpHeaders
- type: "merge" | "reset" = 'merge'
Returns ReqFetch
Inherited from ReqBase.setHeaders
- Defined in src/common/lib/ReqFetch.ts:97

`Static`getInstance

getInstance(): ReqFetch
Returns ReqFetch
- Defined in src/common/lib/ReqFetch.ts:112

Class ReqFetch

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ReqFetch

Properties

Protectedconfig

Protectedheaders

ProtectedisBrowser

Staticinstance

Methods

ProtectedformatUrl

Parameters

Returns URL

get

Type Parameters

Parameters

Returns Promise<{ buffer: ArrayBuffer; data: T; response: Response }>

getConfig

Returns { baseURL?: string; cookie?: string; headers?: OutgoingHttpHeaders; reqOptions?: ReqOptions | RequestOptions;}

getCookie

Parameters

Returns string

Parameters

Returns Record<string, string>

getHeaders

Parameters

Returns OutgoingHttpHeaders

post

Type Parameters

Parameters

Returns Promise<{ buffer: ArrayBuffer; data: T; response: Response }>

req

Parameters

Returns Promise<Response>

request

Type Parameters

Parameters

Returns Promise<{ buffer: ArrayBuffer; data: T; response: Response }>

setConfig

Parameters

Returns void

setHeaders

Parameters

Returns ReqFetch

StaticgetInstance

Returns ReqFetch

Settings

On This Page

`Protected`config

`Protected`headers

`Protected`isBrowser

`Static`instance

`Protected`formatUrl

Returns {
baseURL?: string;
cookie?: string;
headers?: OutgoingHttpHeaders;
reqOptions?: ReqOptions | RequestOptions;
}

`Static`getInstance