Class Request

Hierarchy (View Summary)

ReqBase
- Request

Index

Constructors

constructor

new Request(
    cookie?:
        | string
        | Omit<ReqConfig, "reqOptions"> & { reqOptions?: RequestOptions },
    headers?: OutgoingHttpHeaders,
): Request
Parameters
- Optionalcookie: string | Omit<ReqConfig, "reqOptions"> & { reqOptions?: RequestOptions }
- Optionalheaders: OutgoingHttpHeaders
Returns Request
Overrides ReqBase.constructor
- Defined in src/node/lib/request.ts:15

Properties

`Protected`config

config: ReqConfig = {}

`Protected`headers

headers: OutgoingHttpHeaders = ...

`Protected`isBrowser

isBrowser: boolean = ...

`Static`instance

instance: Request

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?: RequestOptions,
): Promise<
    {
        buffer: Buffer;
        data: T;
        headers: IncomingHttpHeaders;
        response: IncomingMessage;
    },
>
Type Parameters
- T = AnyObject
Parameters
- url: string
- Optionalparameters: AnyObject
- Optionalheaders: OutgoingHttpHeaders
- Optionaloptions: RequestOptions
Returns Promise<
    {
        buffer: Buffer;
        data: T;
        headers: IncomingHttpHeaders;
        response: IncomingMessage;
    },
>
- Defined in src/node/lib/request.ts:102

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?: RequestOptions,
): Promise<
    {
        buffer: Buffer;
        data: T;
        headers: IncomingHttpHeaders;
        response: IncomingMessage;
    },
>
Type Parameters
- T = AnyObject
Parameters
- url: string
- parameters: AnyObject
- Optionalheaders: OutgoingHttpHeaders
- Optionaloptions: RequestOptions
Returns Promise<
    {
        buffer: Buffer;
        data: T;
        headers: IncomingHttpHeaders;
        response: IncomingMessage;
    },
>
- Defined in src/node/lib/request.ts:105

req

req(
    url: string | URL,
    parameters?: AnyObject,
    options?: RequestOptions,
    autoRedirect?: boolean,
): Promise<{ req: ClientRequest; res: IncomingMessage }>
Parameters
- url: string | URL
- Optionalparameters: AnyObject
- options: RequestOptions = {}
- autoRedirect: boolean = true
Returns Promise<{ req: ClientRequest; res: IncomingMessage }>
- Defined in src/node/lib/request.ts:18

request

request<T = AnyObject>(
    method: string,
    url: string | URL,
    parameters?: AnyObject,
    options?: RequestOptions,
    autoRedirect?: boolean,
): Promise<
    {
        buffer: Buffer;
        data: T;
        headers: IncomingHttpHeaders;
        response: IncomingMessage;
    },
>
Type Parameters
- T = AnyObject
Parameters
- method: string
- url: string | URL
- Optionalparameters: AnyObject
- Optionaloptions: RequestOptions
- autoRedirect: boolean = true
Returns Promise<
    {
        buffer: Buffer;
        data: T;
        headers: IncomingHttpHeaders;
        response: IncomingMessage;
    },
>
- Defined in src/node/lib/request.ts:69

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"): Request
Parameters
- headers: OutgoingHttpHeaders
- type: "merge" | "reset" = 'merge'
Returns Request
Inherited from ReqBase.setHeaders
- Defined in src/common/lib/ReqFetch.ts:97

`Static`getInstance

getInstance(): Request
Returns Request
- Defined in src/node/lib/request.ts:11

Class Request

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Request

Properties

Protectedconfig

Protectedheaders

ProtectedisBrowser

Staticinstance

Methods

ProtectedformatUrl

Parameters

Returns URL

get

Type Parameters

Parameters

Returns Promise< { buffer: Buffer; data: T; headers: IncomingHttpHeaders; response: IncomingMessage; },>

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: Buffer; data: T; headers: IncomingHttpHeaders; response: IncomingMessage; },>

req

Parameters

Returns Promise<{ req: ClientRequest; res: IncomingMessage }>

request

Type Parameters

Parameters

Returns Promise< { buffer: Buffer; data: T; headers: IncomingHttpHeaders; response: IncomingMessage; },>

setConfig

Parameters

Returns void

setHeaders

Parameters

Returns Request

StaticgetInstance

Returns Request

Settings

On This Page

`Protected`config

`Protected`headers

`Protected`isBrowser

`Static`instance

`Protected`formatUrl

Returns Promise<
{
buffer: Buffer;
data: T;
headers: IncomingHttpHeaders;
response: IncomingMessage;
},
>

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

Returns Promise<
{
buffer: Buffer;
data: T;
headers: IncomingHttpHeaders;
response: IncomingMessage;
},
>

Returns Promise<
{
buffer: Buffer;
data: T;
headers: IncomingHttpHeaders;
response: IncomingMessage;
},
>

`Static`getInstance