RequestHandler | Avocord

Request Handler class

Hierarchy

<internal>.EventEmitter
- RequestHandler

Constructors

constructor

new RequestHandler(ratelimiter: <internal>.Ratelimiter, options: { baseHost: string; token?: string }): <internal>.RequestHandler

Inherited from EventEmitter.constructor
- Defined in node_modules/cloudstorm/node_modules/snowtransfer/dist/RequestHandler.d.ts:66
Create a new request handler

Parameters
- ratelimiter: <internal>.Ratelimiter
  
  ratelimiter to use for ratelimiting requests
- options: { baseHost: string; token?: string }
  
  options
  - baseHost: string
  - Optional token?: string
Returns <internal>.RequestHandler

Properties

Private _applyRatelimitHeaders

_applyRatelimitHeaders: any

Apply the received ratelimit headers to the ratelimit bucket

param bkt: Ratelimit bucket to apply the headers to
param headers: Http headers received from discord

Private _multiPartRequest

_multiPartRequest: any

Execute a multipart/form-data request

param endpoint: Endpoint to use
param method: Http Method to use
param data: data to send
returns: Result of the request

Private _request

_request: any

Execute a normal json request

param endpoint: Endpoint to use
param data: Data to send
param useParams: Whether to send the data in the body or use query params
returns: Result of the request

apiURL

apiURL: string

latency

latency: number

options

options: { baseHost: string; baseURL: string; headers: { Authorization?: string; User-Agent: string } }

Type declaration

baseHost: string
baseURL: string
headers: { Authorization?: string; User-Agent: string }
- Optional Authorization?: string
- User-Agent: string

ratelimiter

ratelimiter: <internal>.Ratelimiter

Static DiscordAPIErrror

DiscordAPIErrror: typeof <internal>.DiscordAPIError

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

addListener<E>(event: E, listener: ((...args: <internal>.HandlerEvents[E]) => any)): <internal>.RequestHandler

Inherited from EventEmitter.addListener
- Defined in node_modules/cloudstorm/node_modules/snowtransfer/dist/RequestHandler.d.ts:31
Type Parameters
- E extends keyof <internal>.HandlerEvents
Parameters
- event: E
- listener: ((...args: <internal>.HandlerEvents[E]) => any)
  - - (...args: <internal>.HandlerEvents[E]): any
    - Parameters
      - Rest ...args: <internal>.HandlerEvents[E]
      Returns any
Returns <internal>.RequestHandler

emit

emit<E>(event: E, ...args: <internal>.HandlerEvents[E]): boolean

Inherited from EventEmitter.emit
- Defined in node_modules/cloudstorm/node_modules/snowtransfer/dist/RequestHandler.d.ts:32
Type Parameters
- E extends keyof <internal>.HandlerEvents
Parameters
- event: E
- Rest ...args: <internal>.HandlerEvents[E]
Returns boolean

eventNames

eventNames(): (keyof <internal>.HandlerEvents)[]

Inherited from EventEmitter.eventNames
- Defined in node_modules/cloudstorm/node_modules/snowtransfer/dist/RequestHandler.d.ts:33
Returns (keyof <internal>.HandlerEvents)[]

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners
- Defined in node_modules/@types/node/events.d.ts:20
Returns number

listenerCount

listenerCount(event: keyof <internal>.HandlerEvents): number

Inherited from EventEmitter.listenerCount
- Defined in node_modules/cloudstorm/node_modules/snowtransfer/dist/RequestHandler.d.ts:34
Parameters
- event: keyof <internal>.HandlerEvents
Returns number

listeners

listeners(event: keyof <internal>.HandlerEvents): ((...args: any[]) => any)[]

Inherited from EventEmitter.listeners
- Defined in node_modules/cloudstorm/node_modules/snowtransfer/dist/RequestHandler.d.ts:35
Parameters
- event: keyof <internal>.HandlerEvents
Returns ((...args: any[]) => any)[]

off

off<E>(event: E, listener: ((...args: <internal>.HandlerEvents[E]) => any)): <internal>.RequestHandler

Inherited from EventEmitter.off
- Defined in node_modules/cloudstorm/node_modules/snowtransfer/dist/RequestHandler.d.ts:36
Type Parameters
- E extends keyof <internal>.HandlerEvents
Parameters
- event: E
- listener: ((...args: <internal>.HandlerEvents[E]) => any)
  - - (...args: <internal>.HandlerEvents[E]): any
    - Parameters
      - Rest ...args: <internal>.HandlerEvents[E]
      Returns any
Returns <internal>.RequestHandler

on

on<E>(event: E, listener: ((...args: <internal>.HandlerEvents[E]) => any)): <internal>.RequestHandler

Inherited from EventEmitter.on
- Defined in node_modules/cloudstorm/node_modules/snowtransfer/dist/RequestHandler.d.ts:37
Type Parameters
- E extends keyof <internal>.HandlerEvents
Parameters
- event: E
- listener: ((...args: <internal>.HandlerEvents[E]) => any)
  - - (...args: <internal>.HandlerEvents[E]): any
    - Parameters
      - Rest ...args: <internal>.HandlerEvents[E]
      Returns any
Returns <internal>.RequestHandler

once

once<E>(event: E, listener: ((...args: <internal>.HandlerEvents[E]) => any)): <internal>.RequestHandler

Inherited from EventEmitter.once
- Defined in node_modules/cloudstorm/node_modules/snowtransfer/dist/RequestHandler.d.ts:38
Type Parameters
- E extends keyof <internal>.HandlerEvents
Parameters
- event: E
- listener: ((...args: <internal>.HandlerEvents[E]) => any)
  - - (...args: <internal>.HandlerEvents[E]): any
    - Parameters
      - Rest ...args: <internal>.HandlerEvents[E]
      Returns any
Returns <internal>.RequestHandler

prependListener

prependListener<E>(event: E, listener: ((...args: <internal>.HandlerEvents[E]) => any)): <internal>.RequestHandler

Inherited from EventEmitter.prependListener
- Defined in node_modules/cloudstorm/node_modules/snowtransfer/dist/RequestHandler.d.ts:39
Type Parameters
- E extends keyof <internal>.HandlerEvents
Parameters
- event: E
- listener: ((...args: <internal>.HandlerEvents[E]) => any)
  - - (...args: <internal>.HandlerEvents[E]): any
    - Parameters
      - Rest ...args: <internal>.HandlerEvents[E]
      Returns any
Returns <internal>.RequestHandler

prependOnceListener

prependOnceListener<E>(event: E, listener: ((...args: <internal>.HandlerEvents[E]) => any)): <internal>.RequestHandler

Inherited from EventEmitter.prependOnceListener
- Defined in node_modules/cloudstorm/node_modules/snowtransfer/dist/RequestHandler.d.ts:40
Type Parameters
- E extends keyof <internal>.HandlerEvents
Parameters
- event: E
- listener: ((...args: <internal>.HandlerEvents[E]) => any)
  - - (...args: <internal>.HandlerEvents[E]): any
    - Parameters
      - Rest ...args: <internal>.HandlerEvents[E]
      Returns any
Returns <internal>.RequestHandler

rawListeners

rawListeners(event: keyof <internal>.HandlerEvents): ((...args: any[]) => any)[]

Inherited from EventEmitter.rawListeners
- Defined in node_modules/cloudstorm/node_modules/snowtransfer/dist/RequestHandler.d.ts:41
Parameters
- event: keyof <internal>.HandlerEvents
Returns ((...args: any[]) => any)[]

removeAllListeners

removeAllListeners(event?: keyof <internal>.HandlerEvents): <internal>.RequestHandler

Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/cloudstorm/node_modules/snowtransfer/dist/RequestHandler.d.ts:42
Parameters
- Optional event: keyof <internal>.HandlerEvents
Returns <internal>.RequestHandler

removeListener

removeListener<E>(event: E, listener: ((...args: <internal>.HandlerEvents[E]) => any)): <internal>.RequestHandler

Inherited from EventEmitter.removeListener
- Defined in node_modules/cloudstorm/node_modules/snowtransfer/dist/RequestHandler.d.ts:43
Type Parameters
- E extends keyof <internal>.HandlerEvents
Parameters
- event: E
- listener: ((...args: <internal>.HandlerEvents[E]) => any)
  - - (...args: <internal>.HandlerEvents[E]): any
    - Parameters
      - Rest ...args: <internal>.HandlerEvents[E]
      Returns any
Returns <internal>.RequestHandler

request

request(endpoint: string, method: <internal>.HTTPMethod, dataType?: "json" | "multipart", data?: any): Promise<any>

- Defined in node_modules/cloudstorm/node_modules/snowtransfer/dist/RequestHandler.d.ts:78
Request a route from the discord api

Parameters
- endpoint: string
  
  endpoint to request
- method: <internal>.HTTPMethod
  
  http method to use
- Optional dataType: "json" | "multipart"
  
  type of the data being sent
- Optional data: any
  
  data to send, if any
Returns Promise<any>
Result of the request

setMaxListeners

setMaxListeners(n: number): <internal>.RequestHandler

Inherited from EventEmitter.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:19
Parameters
- n: number
Returns <internal>.RequestHandler

Static listenerCount

listenerCount(emitter: <internal>.EventEmitter, event: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:8
deprecated
since v4.0.0

Parameters
- emitter: <internal>.EventEmitter
- event: string | symbol
Returns number

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

ratelimiter: <internal>.Ratelimiter

options: { baseHost: string; token?: string }

baseHost: string

Optional token?: string

Returns <internal>.RequestHandler

Properties

Private _applyRatelimitHeaders

Private _multiPartRequest

Private _request

apiURL

latency

options

Type declaration

baseHost: string

baseURL: string

headers: { Authorization?: string; User-Agent: string }

Optional Authorization?: string

User-Agent: string

ratelimiter

Static DiscordAPIErrror

Static defaultMaxListeners

Methods

addListener

Type Parameters

E extends keyof <internal>.HandlerEvents

Parameters

event: E

listener: ((...args: <internal>.HandlerEvents[E]) => any)

Parameters

Rest ...args: <internal>.HandlerEvents[E]

Returns any

Returns <internal>.RequestHandler

emit

Type Parameters

E extends keyof <internal>.HandlerEvents

Parameters

event: E

Rest ...args: <internal>.HandlerEvents[E]

Returns boolean

eventNames

Returns (keyof <internal>.HandlerEvents)[]

getMaxListeners

Returns number

listenerCount

Parameters

event: keyof <internal>.HandlerEvents

Returns number

listeners

Parameters

event: keyof <internal>.HandlerEvents

Returns ((...args: any[]) => any)[]

off

Type Parameters

E extends keyof <internal>.HandlerEvents

Parameters

event: E

listener: ((...args: <internal>.HandlerEvents[E]) => any)

Parameters

Rest ...args: <internal>.HandlerEvents[E]

Returns any

Returns <internal>.RequestHandler

on

Type Parameters

E extends keyof <internal>.HandlerEvents

Parameters

event: E

listener: ((...args: <internal>.HandlerEvents[E]) => any)

Parameters

Rest ...args: <internal>.HandlerEvents[E]

Returns any

Returns <internal>.RequestHandler

once