Class REST

Represents the class that manages handlers for endpoints

Hierarchy (View Summary)

AsyncEventEmitter<RestEvents>
- REST

Constructors

constructor

new REST(options?: Partial<RESTOptions>): REST
Parameters
- Optionaloptions: Partial<RESTOptions>
Returns REST
Overrides AsyncEventEmitter.constructor
- Defined in node_modules/@discordjs/rest/dist/index.d.ts:837

Properties

`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

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

`Readonly`handlers

handlers: Collection<string, IHandler>

Request handlers created from the bucket hash and the major parameters

`Readonly`hashes

hashes: Collection<string, HashData>

API bucket hashes that are cached from provided routes

`Readonly`options

options: RESTOptions

Methods

addListener

addListener<
    K extends (keyof AsyncEventEmitterPredefinedEvents)
    | (keyof RestEvents),
>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<RestEvents>,
            K,
            RestEvents,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof RestEvents)
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<RestEvents>,
          K,
          RestEvents,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AsyncEventEmitter.addListener
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:17
addListener<K extends string | symbol>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<RestEvents>,
            K,
            RestEvents,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends string | symbol
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<RestEvents>,
          K,
          RestEvents,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AsyncEventEmitter.addListener
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:18

clearHandlerSweeper

clearHandlerSweeper(): void
Stops the request handler sweeping interval

Returns void
- Defined in node_modules/@discordjs/rest/dist/index.d.ts:920

clearHashSweeper

clearHashSweeper(): void
Stops the hash sweeping interval

Returns void
- Defined in node_modules/@discordjs/rest/dist/index.d.ts:916

delete

delete(fullRoute: `/${string}`, options?: RequestData): Promise<unknown>
Runs a delete request from the api
Parameters
- fullRoute: `/${string}`
  The full route to query
- Optionaloptions: RequestData
  Optional request options
Returns Promise<unknown>
- Defined in node_modules/@discordjs/rest/dist/index.d.ts:852

emit

emit<K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof RestEvents)>(
    eventName: K,
    ...args: InternalGetAsyncEventEmitterEventParameters<
        AsyncEventEmitter<RestEvents>,
        K,
    >,
): boolean
Type Parameters
- K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof RestEvents)
Parameters
- eventName: K
- ...args: InternalGetAsyncEventEmitterEventParameters<AsyncEventEmitter<RestEvents>, K>
Returns boolean
Inherited from AsyncEventEmitter.emit
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:37
emit<K extends string | symbol>(
    eventName: K,
    ...args: InternalGetAsyncEventEmitterEventParameters<
        AsyncEventEmitter<RestEvents>,
        K,
    >,
): boolean
Type Parameters
- K extends string | symbol
Parameters
- eventName: K
- ...args: InternalGetAsyncEventEmitterEventParameters<AsyncEventEmitter<RestEvents>, K>
Returns boolean
Inherited from AsyncEventEmitter.emit
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:38

eventNames

eventNames(): (string | symbol)[] & (keyof AsyncEventEmitterPredefinedEvents)[] & (
keyof RestEvents
)[]
Returns (string | symbol)[] & (keyof AsyncEventEmitterPredefinedEvents)[] & (
keyof RestEvents
)[]
Inherited from AsyncEventEmitter.eventNames
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:45

get

get(fullRoute: `/${string}`, options?: RequestData): Promise<unknown>
Runs a get request from the api
Parameters
- fullRoute: `/${string}`
  The full route to query
- Optionaloptions: RequestData
  Optional request options
Returns Promise<unknown>
- Defined in node_modules/@discordjs/rest/dist/index.d.ts:845

getMaxListeners

getMaxListeners(): number
Returns number
Inherited from AsyncEventEmitter.getMaxListeners
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:32

listenerCount

listenerCount<
    K extends (keyof AsyncEventEmitterPredefinedEvents)
    | (keyof RestEvents),
>(
    eventName: K,
): number
Type Parameters
- K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof RestEvents)
Parameters
- eventName: K
Returns number
Inherited from AsyncEventEmitter.listenerCount
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:39
listenerCount(eventName: string | symbol): number
Parameters
- eventName: string | symbol
Returns number
Inherited from AsyncEventEmitter.listenerCount
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:40

listeners

listeners<
    K extends (keyof AsyncEventEmitterPredefinedEvents)
    | (keyof RestEvents),
>(
    eventName: K,
): Exclude<
    InternalAsyncEventEmitterInternalListenerForEvent<
        AsyncEventEmitter<RestEvents>,
        K,
        RestEvents,
    >["listener"],
    undefined,
>[]
Type Parameters
- K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof RestEvents)
Parameters
- eventName: K
Returns Exclude<
    InternalAsyncEventEmitterInternalListenerForEvent<
        AsyncEventEmitter<RestEvents>,
        K,
        RestEvents,
    >["listener"],
    undefined,
>[]
Inherited from AsyncEventEmitter.listeners
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:33
listeners<K extends string | symbol>(
    eventName: K,
): 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,
>[]
Inherited from AsyncEventEmitter.listeners
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:34

off

off<K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof RestEvents)>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<RestEvents>,
            K,
            RestEvents,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof RestEvents)
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<RestEvents>,
          K,
          RestEvents,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AsyncEventEmitter.off
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:25
off<K extends string | symbol>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<RestEvents>,
            K,
            RestEvents,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends string | symbol
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<RestEvents>,
          K,
          RestEvents,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AsyncEventEmitter.off
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:26

on

on<K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof RestEvents)>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<RestEvents>,
            K,
            RestEvents,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof RestEvents)
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<RestEvents>,
          K,
          RestEvents,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AsyncEventEmitter.on
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:19
on<K extends string | symbol>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<RestEvents>,
            K,
            RestEvents,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends string | symbol
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<RestEvents>,
          K,
          RestEvents,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AsyncEventEmitter.on
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:20

once

once<K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof RestEvents)>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<RestEvents>,
            K,
            RestEvents,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof RestEvents)
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<RestEvents>,
          K,
          RestEvents,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AsyncEventEmitter.once
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:21
once<K extends string | symbol>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<RestEvents>,
            K,
            RestEvents,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends string | symbol
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<RestEvents>,
          K,
          RestEvents,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AsyncEventEmitter.once
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:22

patch

patch(fullRoute: `/${string}`, options?: RequestData): Promise<unknown>
Runs a patch request from the api
Parameters
- fullRoute: `/${string}`
  The full route to query
- Optionaloptions: RequestData
  Optional request options
Returns Promise<unknown>
- Defined in node_modules/@discordjs/rest/dist/index.d.ts:873

post

post(fullRoute: `/${string}`, options?: RequestData): Promise<unknown>
Runs a post request from the api
Parameters
- fullRoute: `/${string}`
  The full route to query
- Optionaloptions: RequestData
  Optional request options
Returns Promise<unknown>
- Defined in node_modules/@discordjs/rest/dist/index.d.ts:859

prependListener

prependListener<
    K extends (keyof AsyncEventEmitterPredefinedEvents)
    | (keyof RestEvents),
>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<RestEvents>,
            K,
            RestEvents,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof RestEvents)
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<RestEvents>,
          K,
          RestEvents,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AsyncEventEmitter.prependListener
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:41
prependListener<K extends string | symbol>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<RestEvents>,
            K,
            RestEvents,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends string | symbol
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<RestEvents>,
          K,
          RestEvents,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AsyncEventEmitter.prependListener
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:42

prependOnceListener

prependOnceListener<
    K extends (keyof AsyncEventEmitterPredefinedEvents)
    | (keyof RestEvents),
>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<RestEvents>,
            K,
            RestEvents,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof RestEvents)
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<RestEvents>,
          K,
          RestEvents,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AsyncEventEmitter.prependOnceListener
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:43
prependOnceListener<K extends string | symbol>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<RestEvents>,
            K,
            RestEvents,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends string | symbol
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<RestEvents>,
          K,
          RestEvents,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AsyncEventEmitter.prependOnceListener
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:44

put

put(fullRoute: `/${string}`, options?: RequestData): Promise<unknown>
Runs a put request from the api
Parameters
- fullRoute: `/${string}`
  The full route to query
- Optionaloptions: RequestData
  Optional request options
Returns Promise<unknown>
- Defined in node_modules/@discordjs/rest/dist/index.d.ts:866

queueRequest

queueRequest(request: InternalRequest): Promise<ResponseLike>
Queues a request to be sent
Parameters
- request: InternalRequest
  All the information needed to make a request
Returns Promise<ResponseLike>
The response from the api request
- Defined in node_modules/@discordjs/rest/dist/index.d.ts:898

rawListeners

rawListeners<
    K extends (keyof AsyncEventEmitterPredefinedEvents)
    | (keyof RestEvents),
>(
    eventName: K,
): InternalAsyncEventEmitterInternalListenerForEvent<
    AsyncEventEmitter<RestEvents>,
    K,
    RestEvents,
>[]
Type Parameters
- K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof RestEvents)
Parameters
- eventName: K
Returns InternalAsyncEventEmitterInternalListenerForEvent<
    AsyncEventEmitter<RestEvents>,
    K,
    RestEvents,
>[]
Inherited from AsyncEventEmitter.rawListeners
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:35
rawListeners<K extends string | symbol>(
    eventName: K,
): InternalAsyncEventEmitterInternalListenerForEvent<
    AsyncEventEmitter<RestEvents>,
    K,
    RestEvents,
>[]
Type Parameters
- K extends string | symbol
Parameters
- eventName: K
Returns InternalAsyncEventEmitterInternalListenerForEvent<
    AsyncEventEmitter<RestEvents>,
    K,
    RestEvents,
>[]
Inherited from AsyncEventEmitter.rawListeners
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:36

removeAllListeners

removeAllListeners<
    K extends (keyof AsyncEventEmitterPredefinedEvents)
    | (keyof RestEvents),
>(
    event: K,
): this
Type Parameters
- K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof RestEvents)
Parameters
- event: K
Returns this
Inherited from AsyncEventEmitter.removeAllListeners
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:27
removeAllListeners<
    K extends (keyof AsyncEventEmitterPredefinedEvents)
    | (keyof RestEvents),
>(
    event?: K,
): this
Type Parameters
- K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof RestEvents)
Parameters
- Optionalevent: K
Returns this
Inherited from AsyncEventEmitter.removeAllListeners
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:28
removeAllListeners(event: string | symbol): this
Parameters
- event: string | symbol
Returns this
Inherited from AsyncEventEmitter.removeAllListeners
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:29
removeAllListeners(event?: string | symbol): this
Parameters
- Optionalevent: string | symbol
Returns this
Inherited from AsyncEventEmitter.removeAllListeners
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:30

removeListener

removeListener<
    K extends (keyof AsyncEventEmitterPredefinedEvents)
    | (keyof RestEvents),
>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<RestEvents>,
            K,
            RestEvents,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof RestEvents)
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<RestEvents>,
          K,
          RestEvents,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AsyncEventEmitter.removeListener
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:23
removeListener<K extends string | symbol>(
    eventName: K,
    listener: Exclude<
        InternalAsyncEventEmitterInternalListenerForEvent<
            AsyncEventEmitter<RestEvents>,
            K,
            RestEvents,
        >["listener"],
        undefined,
    >,
): this
Type Parameters
- K extends string | symbol
Parameters
- eventName: K
- listener: Exclude<
      InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<RestEvents>,
          K,
          RestEvents,
      >["listener"],
      undefined,
  >
Returns this
Inherited from AsyncEventEmitter.removeListener
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:24

request

request(options: InternalRequest): Promise<unknown>
Runs a request from the api
Parameters
- options: InternalRequest
  Request options
Returns Promise<unknown>
- Defined in node_modules/@discordjs/rest/dist/index.d.ts:879

setAgent

setAgent(agent: Dispatcher): this
Sets the default agent to use for requests performed by this manager
Parameters
- agent: Dispatcher
  The agent to use
Returns this
- Defined in node_modules/@discordjs/rest/dist/index.d.ts:885

setMaxListeners

setMaxListeners(n: number): this
Parameters
- n: number
Returns this
Inherited from AsyncEventEmitter.setMaxListeners
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:31

setToken

setToken(token: string): this
Sets the authorization token that should be used for requests
Parameters
- token: string
  The authorization token to use
Returns this
- Defined in node_modules/@discordjs/rest/dist/index.d.ts:891

waitForAllListenersToComplete

waitForAllListenersToComplete(): Promise<boolean>
Returns Promise<boolean>
Inherited from AsyncEventEmitter.waitForAllListenersToComplete
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:46

`Static`listenerCount

listenerCount<
    EventMap extends {},
    EventName extends
        PropertyKey =
        | (keyof AsyncEventEmitterPredefinedEvents)
        | keyof EventMap,
>(
    emitter: AsyncEventEmitter<EventMap>,
    eventName: (keyof AsyncEventEmitterPredefinedEvents) | EventName,
): number
Type Parameters
- EventMap extends {}
- EventName extends PropertyKey = (keyof AsyncEventEmitterPredefinedEvents) | keyof EventMap
Parameters
- emitter: AsyncEventEmitter<EventMap>
- eventName: (keyof AsyncEventEmitterPredefinedEvents) | EventName
Returns number
Inherited from AsyncEventEmitter.listenerCount
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:49
listenerCount(
emitter: AsyncEventEmitter<any>,
eventName: string | symbol,
): number
Parameters
- emitter: AsyncEventEmitter<any>
- eventName: string | symbol
Returns number
Inherited from AsyncEventEmitter.listenerCount
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:50

`Static`on

on<
    EventMap extends {},
    EventName extends
        PropertyKey =
        | (keyof AsyncEventEmitterPredefinedEvents)
        | keyof EventMap,
>(
    emitter: AsyncEventEmitter<EventMap>,
    eventName: EventName,
    options?: AbortableMethods,
): AsyncGenerator<
    InternalGetAsyncEventEmitterEventParameters<
        AsyncEventEmitter<EventMap>,
        EventName,
        EventMap,
    >,
    void,
>
Type Parameters
- EventMap extends {}
- EventName extends PropertyKey = (keyof AsyncEventEmitterPredefinedEvents) | keyof EventMap
Parameters
- emitter: AsyncEventEmitter<EventMap>
- eventName: EventName
- Optionaloptions: AbortableMethods
Returns AsyncGenerator<
    InternalGetAsyncEventEmitterEventParameters<
        AsyncEventEmitter<EventMap>,
        EventName,
        EventMap,
    >,
    void,
>
Inherited from AsyncEventEmitter.on
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:53
on(
    emitter: AsyncEventEmitter<any>,
    eventName: string | symbol,
    options?: AbortableMethods,
): AsyncGenerator<any[], void>
Parameters
- emitter: AsyncEventEmitter<any>
- eventName: string | symbol
- Optionaloptions: AbortableMethods
Returns AsyncGenerator<any[], void>
Inherited from AsyncEventEmitter.on
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:54

`Static`once

once<
    EventMap extends {},
    EventName extends
        PropertyKey =
        | (keyof AsyncEventEmitterPredefinedEvents)
        | keyof EventMap,
>(
    emitter: AsyncEventEmitter<EventMap>,
    eventName: EventName,
    options?: AbortableMethods,
): Promise<
    InternalGetAsyncEventEmitterEventParameters<
        AsyncEventEmitter<EventMap>,
        EventName,
        EventMap,
    >,
>
Type Parameters
- EventMap extends {}
- EventName extends PropertyKey = (keyof AsyncEventEmitterPredefinedEvents) | keyof EventMap
Parameters
- emitter: AsyncEventEmitter<EventMap>
- eventName: EventName
- Optionaloptions: AbortableMethods
Returns Promise<
    InternalGetAsyncEventEmitterEventParameters<
        AsyncEventEmitter<EventMap>,
        EventName,
        EventMap,
    >,
>
Inherited from AsyncEventEmitter.once
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:51
once(
    emitter: AsyncEventEmitter<any>,
    eventName: string | symbol,
    options?: AbortableMethods,
): Promise<any[]>
Parameters
- emitter: AsyncEventEmitter<any>
- eventName: string | symbol
- Optionaloptions: AbortableMethods
Returns Promise<any[]>
Inherited from AsyncEventEmitter.once
- Defined in node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:52

Class REST

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns REST

Properties

Protected Readonly[brandSymbol]

agent

Readonlycdn

globalDelay

globalRemaining

globalReset

Readonlyhandlers

Readonlyhashes

Readonlyoptions

Methods

addListener

Type Parameters

Parameters

Returns this

Type Parameters

Parameters

Returns this

clearHandlerSweeper

Returns void

clearHashSweeper

Returns void

delete

Parameters

Returns Promise<unknown>

emit

Type Parameters

Parameters

Returns boolean

Type Parameters

Parameters

Returns boolean

eventNames

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

get

Parameters

Returns Promise<unknown>

getMaxListeners

Returns number

listenerCount

Type Parameters

Parameters

Returns number

Parameters

Returns number

listeners

Type Parameters

Parameters

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

Type Parameters

Parameters

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

off

Type Parameters

Parameters

Returns this

Type Parameters

Parameters

Returns this

on

Type Parameters

Parameters

Returns this

Type Parameters

Parameters

Returns this

once

Type Parameters

Parameters

Returns this

`Protected` `Readonly`[brandSymbol]

`Readonly`cdn

`Readonly`handlers

`Readonly`hashes

`Readonly`options

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

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

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

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

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

`Static`listenerCount