Class RestClient<E>

Type Parameters

E extends EventMap = never

Hierarchy (View Summary)

TypedEventEmitter<E>
- RestClient
  - WebSocketClient

Index

Constructors

Properties

_auth _logger baseUrl listeners

Accessors

Methods

emit get off on once post

Constructors

constructor

new RestClient<E extends EventMap = never>(
baseUrl: string,
logger: Logger,
): RestClient<E>
Type Parameters
- E extends EventMap = never
Parameters
- baseUrl: string
- logger: Logger
Returns RestClient<E>
Overrides TypedEventEmitter.constructor
- Defined in lib/RestClient.ts:15

Properties

`Protected`_auth

_auth: null | AuthData = null

`Protected`_logger

_logger: Logger

`Readonly`baseUrl

baseUrl: string

`Protected`listeners

listeners: { [K in string | number | symbol]?: (data: E[K]) => void[] } = {}

Accessors

auth

get auth(): null | AuthData
Returns null | AuthData
- Defined in lib/RestClient.ts:21
set auth(auth: null | AuthData): void
Parameters
- auth: null | AuthData
Returns void
- Defined in lib/RestClient.ts:25

Methods

`Protected`emit

emit<T extends string | number | symbol>(event: T, data: E[T]): void
Dispatch an event to all listeners
Type Parameters
- T extends string | number | symbol
Parameters
- event: T
- data: E[T]
Returns void
Inherited from TypedEventEmitter.emit
- Defined in lib/TypedEventEmitter.ts:57

get

get<T = JSONValue>(path: string, query?: Record<string, any>): Promise<T>
Type Parameters
- T = JSONValue
Parameters
- path: string
- query: Record<string, any> = {}
Returns Promise<T>
- Defined in lib/RestClient.ts:61

off

off<T extends string | number | symbol>(
event: T,
listener: (data: E[T]) => void,
): void
Remove an event listener
Type Parameters
- T extends string | number | symbol
Parameters
- event: T
- listener: (data: E[T]) => void
Returns void
Inherited from TypedEventEmitter.off
- Defined in lib/TypedEventEmitter.ts:45

on

on<T extends string | number | symbol>(
event: T,
listener: (data: E[T]) => void,
): () => void
Add an event listener, returns a function that can be called to remove the listener
Type Parameters
- T extends string | number | symbol
Parameters
- event: T
- listener: (data: E[T]) => void
Returns () => void
Inherited from TypedEventEmitter.on
- Defined in lib/TypedEventEmitter.ts:17

once

once<T extends string | number | symbol>(
event: T,
listener: (data: E[T]) => void,
): () => void
Add an event listener that will be called only once
Type Parameters
- T extends string | number | symbol
Parameters
- event: T
- listener: (data: E[T]) => void
Returns () => void
Inherited from TypedEventEmitter.once
- Defined in lib/TypedEventEmitter.ts:32

post

post<T = JSONValue>(path: string, body?: Record<string, unknown>): Promise<T>
Type Parameters
- T = JSONValue
Parameters
- path: string
- body: Record<string, unknown> = {}
Returns Promise<T>
- Defined in lib/RestClient.ts:65