Class REST

Represents the class that manages handlers for endpoints

Hierarchy

Constructors

constructor

Properties

#private [brandSymbol] agent cdn createHandler globalDelay globalRemaining globalReset handlerTimer handlers hashTimer hashes options resolveRequest setupSweepers generateRouteData

Methods

addListener clearHandlerSweeper clearHashSweeper delete emit eventNames get getMaxListeners listenerCount listeners off on once patch post prependListener prependOnceListener put queueRequest rawListeners removeAllListeners removeListener request setAgent setMaxListeners setToken waitForAllListenersToComplete listenerCount on once

Constructors

constructor

  • Parameters

    Returns REST

Properties

Private #private

#private: any

Protected Readonly [brandSymbol]

[brandSymbol]: RestEvents

This field doesn't actually exist, it's just a way to make TS properly infer the events from classes that extend AsyncEventEmitter

agent

agent: null | Dispatcher

The Agent for all requests performed by this manager.

Readonly cdn

cdn: CDN

Private Internal createHandler

createHandler: any

Creates a new rate limit handler from a hash, based on the hash and the major parameter

Param

The hash for the route

Param

The major parameter for this handler

globalDelay

globalDelay: null | Promise<void>

The promise used to wait out the global rate limit

globalRemaining

globalRemaining: number

The number of requests remaining in the global bucket

globalReset

globalReset: number

The timestamp at which the global bucket resets

Private handlerTimer

handlerTimer: any

Readonly handlers

handlers: Collection<string, IHandler>

Request handlers created from the bucket hash and the major parameters

Private hashTimer

hashTimer: any

Readonly hashes

hashes: Collection<string, HashData>

API bucket hashes that are cached from provided routes

Readonly options

options: RESTOptions

Private resolveRequest

resolveRequest: any

Formats the request data to a usable format for fetch

Param

The request data

Private setupSweepers

setupSweepers: any

Static Private Internal generateRouteData

generateRouteData: any

Generates route data for an endpoint:method

Param

The raw endpoint to generalize

Param

The HTTP method this endpoint is called without

Methods

addListener

  • Type Parameters

    • K extends keyof AsyncEventEmitterPredefinedEvents | keyof RestEvents

    Parameters

    • eventName: K
    • listener: Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<RestEvents>, K, RestEvents>["listener"], undefined>

    Returns REST

  • Type Parameters

    • K extends string | symbol

    Parameters

    • eventName: K
    • listener: Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<RestEvents>, K, RestEvents>["listener"], undefined>

    Returns REST

clearHandlerSweeper

  • Stops the request handler sweeping interval

    Returns void

clearHashSweeper

  • Stops the hash sweeping interval

    Returns void

delete

  • Runs a delete request from the api

    Parameters

    • fullRoute: `/${string}`

      The full route to query

    • Optional options: RequestData

      Optional request options

    Returns Promise<unknown>

emit

  • Type Parameters

    • K extends keyof AsyncEventEmitterPredefinedEvents | keyof RestEvents

    Parameters

    • eventName: K
    • Rest ...args: InternalGetAsyncEventEmitterEventParameters<AsyncEventEmitter<RestEvents>, K, RestEvents>

    Returns boolean

  • Type Parameters

    • K extends string | symbol

    Parameters

    • eventName: K
    • Rest ...args: InternalGetAsyncEventEmitterEventParameters<AsyncEventEmitter<RestEvents>, K, RestEvents>

    Returns boolean

eventNames

  • Returns (string | symbol)[] & (keyof AsyncEventEmitterPredefinedEvents)[] & (keyof RestEvents)[]

get

  • Runs a get request from the api

    Parameters

    • fullRoute: `/${string}`

      The full route to query

    • Optional options: RequestData

      Optional request options

    Returns Promise<unknown>

getMaxListeners

  • Returns number

listenerCount

  • Type Parameters

    • K extends keyof AsyncEventEmitterPredefinedEvents | keyof RestEvents

    Parameters

    • eventName: K

    Returns number

  • Parameters

    • eventName: string | symbol

    Returns number

listeners

  • Type Parameters

    • K extends keyof AsyncEventEmitterPredefinedEvents | keyof RestEvents

    Parameters

    • eventName: K

    Returns Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<RestEvents>, K, RestEvents>["listener"], undefined>[]

  • Type Parameters

    • K extends string | symbol

    Parameters

    • eventName: K

    Returns Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<RestEvents>, K, RestEvents>["listener"], undefined>[]

off

  • Type Parameters

    • K extends keyof AsyncEventEmitterPredefinedEvents | keyof RestEvents

    Parameters

    • eventName: K
    • listener: Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<RestEvents>, K, RestEvents>["listener"], undefined>

    Returns REST

  • Type Parameters

    • K extends string | symbol

    Parameters

    • eventName: K
    • listener: Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<RestEvents>, K, RestEvents>["listener"], undefined>

    Returns REST

on

  • Type Parameters

    • K extends keyof AsyncEventEmitterPredefinedEvents | keyof RestEvents

    Parameters

    • eventName: K
    • listener: Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<RestEvents>, K, RestEvents>["listener"], undefined>

    Returns REST

  • Type Parameters

    • K extends string | symbol

    Parameters

    • eventName: K
    • listener: Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<RestEvents>, K, RestEvents>["listener"], undefined>

    Returns REST

once

  • Type Parameters

    • K extends keyof AsyncEventEmitterPredefinedEvents | keyof RestEvents

    Parameters

    • eventName: K
    • listener: Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<RestEvents>, K, RestEvents>["listener"], undefined>

    Returns REST

  • Type Parameters

    • K extends string | symbol

    Parameters

    • eventName: K
    • listener: Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<RestEvents>, K, RestEvents>["listener"], undefined>

    Returns REST

patch

  • Runs a patch request from the api

    Parameters

    • fullRoute: `/${string}`

      The full route to query

    • Optional options: RequestData

      Optional request options

    Returns Promise<unknown>

post

  • Runs a post request from the api

    Parameters

    • fullRoute: `/${string}`

      The full route to query

    • Optional options: RequestData

      Optional request options

    Returns Promise<unknown>

prependListener

  • Type Parameters

    • K extends keyof AsyncEventEmitterPredefinedEvents | keyof RestEvents

    Parameters

    • eventName: K
    • listener: Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<RestEvents>, K, RestEvents>["listener"], undefined>

    Returns REST

  • Type Parameters

    • K extends string | symbol

    Parameters

    • eventName: K
    • listener: Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<RestEvents>, K, RestEvents>["listener"], undefined>

    Returns REST

prependOnceListener

  • Type Parameters

    • K extends keyof AsyncEventEmitterPredefinedEvents | keyof RestEvents

    Parameters

    • eventName: K
    • listener: Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<RestEvents>, K, RestEvents>["listener"], undefined>

    Returns REST

  • Type Parameters

    • K extends string | symbol

    Parameters

    • eventName: K
    • listener: Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<RestEvents>, K, RestEvents>["listener"], undefined>

    Returns REST

put

  • Runs a put request from the api

    Parameters

    • fullRoute: `/${string}`

      The full route to query

    • Optional options: RequestData

      Optional request options

    Returns Promise<unknown>

queueRequest

  • Queues a request to be sent

    Parameters

    Returns Promise<ResponseLike>

    The response from the api request

rawListeners

  • Type Parameters

    • K extends keyof AsyncEventEmitterPredefinedEvents | keyof RestEvents

    Parameters

    • eventName: K

    Returns InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<RestEvents>, K, RestEvents>[]

  • Type Parameters

    • K extends string | symbol

    Parameters

    • eventName: K

    Returns InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<RestEvents>, K, RestEvents>[]

removeAllListeners

  • Type Parameters

    • K extends keyof AsyncEventEmitterPredefinedEvents | keyof RestEvents

    Parameters

    • event: K

    Returns REST

  • Type Parameters

    • K extends keyof AsyncEventEmitterPredefinedEvents | keyof RestEvents

    Parameters

    • Optional event: K

    Returns REST

  • Parameters

    • event: string | symbol

    Returns REST

  • Parameters

    • Optional event: string | symbol

    Returns REST

removeListener

  • Type Parameters

    • K extends keyof AsyncEventEmitterPredefinedEvents | keyof RestEvents

    Parameters

    • eventName: K
    • listener: Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<RestEvents>, K, RestEvents>["listener"], undefined>

    Returns REST

  • Type Parameters

    • K extends string | symbol

    Parameters

    • eventName: K
    • listener: Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<RestEvents>, K, RestEvents>["listener"], undefined>

    Returns REST

request

  • Runs a request from the api

    Parameters

    Returns Promise<unknown>

setAgent

  • Sets the default agent to use for requests performed by this manager

    Parameters

    • agent: Dispatcher

      The agent to use

    Returns REST

setMaxListeners

  • Parameters

    • n: number

    Returns REST

setToken

  • Sets the authorization token that should be used for requests

    Parameters

    • token: string

      The authorization token to use

    Returns REST

waitForAllListenersToComplete

  • Returns Promise<boolean>

Static listenerCount

  • Type Parameters

    • EventMap extends {}

    • EventName extends PropertyKey = keyof EventMap | keyof AsyncEventEmitterPredefinedEvents

    Parameters

    • emitter: AsyncEventEmitter<EventMap>
    • eventName: EventName | keyof AsyncEventEmitterPredefinedEvents

    Returns number

  • Parameters

    • emitter: AsyncEventEmitter<any>
    • eventName: string | symbol

    Returns number

Static on

  • Type Parameters

    • EventMap extends {}

    • EventName extends PropertyKey = keyof AsyncEventEmitterPredefinedEvents | keyof EventMap

    Parameters

    • emitter: AsyncEventEmitter<EventMap>
    • eventName: EventName
    • Optional options: AbortableMethods

    Returns AsyncGenerator<InternalGetAsyncEventEmitterEventParameters<AsyncEventEmitter<EventMap>, EventName, EventMap>, void, unknown>

  • Parameters

    • emitter: AsyncEventEmitter<any>
    • eventName: string | symbol
    • Optional options: AbortableMethods

    Returns AsyncGenerator<any[], void, unknown>

Static once

  • Type Parameters

    • EventMap extends {}

    • EventName extends PropertyKey = keyof AsyncEventEmitterPredefinedEvents | keyof EventMap

    Parameters

    • emitter: AsyncEventEmitter<EventMap>
    • eventName: EventName
    • Optional options: AbortableMethods

    Returns Promise<InternalGetAsyncEventEmitterEventParameters<AsyncEventEmitter<EventMap>, EventName, EventMap>>

  • Parameters

    • emitter: AsyncEventEmitter<any>
    • eventName: string | symbol
    • Optional options: AbortableMethods

    Returns Promise<any[]>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc