Class Request

Hierarchy (View Summary)

Constructors

constructor

Properties

config cookies headers isBrowser instance

Methods

formatUrl get getCookie getHeaders post req request setCookie setHeaders getInstance

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

Properties

Protectedconfig

config: ReqConfig = {}

Protectedcookies

cookies: Record<string, string> = {}

Protectedheaders

headers: OutgoingHttpHeaders = ...

ProtectedisBrowser

isBrowser: boolean = ...

Staticinstance

instance: Request

Methods

ProtectedformatUrl

get

  • get<T = AnyObject>(
        url: string,
        parameters?: AnyObject,
        headers?: OutgoingHttpHeaders,
        options?: RequestOptions,
    ): Promise<
        {
            buffer: Buffer;
            data: T;
            headers: IncomingHttpHeaders;
            response: IncomingMessage;
        },
    >

  • Type Parameters

    Parameters

    • url: string
    • Optionalparameters: AnyObject
    • Optionalheaders: OutgoingHttpHeaders
    • Optionaloptions: RequestOptions

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

getCookie

getHeaders

  • getHeaders(urlObject?: URL, headers?: OutgoingHttpHeaders): OutgoingHttpHeaders

  • Parameters

    • OptionalurlObject: URL
    • Optionalheaders: OutgoingHttpHeaders

    Returns OutgoingHttpHeaders

post

  • post<T = AnyObject>(
        url: string,
        parameters: AnyObject,
        headers?: OutgoingHttpHeaders,
        options?: RequestOptions,
    ): Promise<
        {
            buffer: Buffer;
            data: T;
            headers: IncomingHttpHeaders;
            response: IncomingMessage;
        },
    >

  • Type Parameters

    Parameters

    • url: string
    • parameters: AnyObject
    • Optionalheaders: OutgoingHttpHeaders
    • Optionaloptions: RequestOptions

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

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 }>

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

    Parameters

    • method: string
    • url: string | URL
    • Optionalparameters: AnyObject
    • Optionaloptions: RequestOptions
    • autoRedirect: boolean = true

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

setCookie

setHeaders

StaticgetInstance

Settings

Member Visibility

On This Page

Constructors
Properties
Methods