Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RequestClient

Hierarchy

  • EventEmitter
    • RequestClient

Index

Constructors

Properties

Methods

Constructors

constructor

  • new RequestClient(options: RequestClientOptions): RequestClient

Properties

Private Optional _agent

_agent: Agent

Private _destroyed

_destroyed: boolean

Private _retries

_retries: Set<{ id: AbortSignal; retry: number }>

Private _timeouts

_timeouts: Set<number | Timeout>

Readonly baseUri

baseUri: string

globalReset

globalReset: null | number

Readonly globalUri

globalUri: string

Protected Readonly headers

headers: Record<string, string>

options

options: RequestClientOptions

Readonly token

token: string

Readonly version

version: Version

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Methods

addListener

  • addListener(event: string | symbol, listener: (...args: any[]) => void): RequestClient

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns RequestClient

Private clearTimeout

  • clearTimeout(tid: Timeout): void

destroy

  • destroy(): void

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]

  • Returns (string | symbol)[]

getMaxListeners

  • getMaxListeners(): number

  • Returns number

listenerCount

  • listenerCount(event: string | symbol): number

  • Parameters

    • event: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

off

  • off(event: string | symbol, listener: (...args: any[]) => void): RequestClient

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns RequestClient

on

  • on(event: "rateLimit" | "timeout" | "request" | "serverCountUpdated", listener: (...args: unknown[]) => void): RequestClient

  • Parameters

    • event: "rateLimit" | "timeout" | "request" | "serverCountUpdated"
    • listener: (...args: unknown[]) => void
        • (...args: unknown[]): void

        • Parameters

          • Rest ...args: unknown[]

          Returns void

    Returns RequestClient

once

  • once(event: string | symbol, listener: (...args: any[]) => void): RequestClient

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns RequestClient

prependListener

  • prependListener(event: string | symbol, listener: (...args: any[]) => void): RequestClient

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns RequestClient

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): RequestClient

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns RequestClient

rawListeners

  • rawListeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

removeAllListeners

  • Parameters

    • Optional event: string | symbol

    Returns RequestClient

removeListener

  • removeListener(event: string | symbol, listener: (...args: any[]) => void): RequestClient

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns RequestClient

request

  • request<T>(method: string, url: string, options?: RequestInitWithInternals): Promise<FetchResponse<T>>

  • Type parameters

    • T = unknown

    Parameters

    • method: string
    • url: string
    • Optional options: RequestInitWithInternals

    Returns Promise<FetchResponse<T>>

setMaxListeners

  • Parameters

    • n: number

    Returns RequestClient

Private setTimeout

  • setTimeout(func: Function, time: number, ...args: unknown[]): Timeout

Private setupReadonly

  • setupReadonly(options: RequestClientOptions): void

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Static on

  • on(emitter: EventEmitter, event: string): AsyncIterableIterator<any>

  • Parameters

    • emitter: EventEmitter
    • event: string

    Returns AsyncIterableIterator<any>

Static once

  • once(emitter: NodeEventTarget, event: string | symbol): Promise<any[]>
  • once(emitter: DOMEventTarget, event: string): Promise<any[]>

  • Parameters

    • emitter: NodeEventTarget
    • event: string | symbol

    Returns Promise<any[]>

  • Parameters

    • emitter: DOMEventTarget
    • event: string

    Returns Promise<any[]>

Static Protected validator

  • validator<T>(): ProxyValidator<T>

Generated using TypeDoc