Class RESTManager

The REST manager for the Guilded API.

Example

new RESTManager({ version: 1, token: 'token' });

Hierarchy

EventEmitter
- RESTManager

Index

Constructors

constructor

new RESTManager(options: RESTOptions): RESTManager
Parameters
- options: RESTOptions
  
  The options for the REST manager.
Returns RESTManager
Overrides EventEmitter.constructor
- Defined in rest/src/RESTManager.ts:24

Properties

`Readonly` options

options: RESTOptions

The options for the REST manager.

`Optional` `Readonly` proxyUrl

proxyUrl?: string

The proxy url of the REST API.

`Readonly` router

router: Router

The router for the REST API.

`Optional` token

token?: string

The auth token for the REST API.

`Optional` `Readonly` version

version?: number

The version of the REST API.

Accessors

baseURL

get baseURL(): string
The base URL for the REST API.

Returns string
- Defined in rest/src/RESTManager.ts:33

Methods

delete

delete<R>(path: string): Promise<R>
Make a DELETE request to the REST API.

Returns
The response from the REST API.

Example
```
rest.delete('/channels/abc');
```
Type Parameters
- R
Parameters
- path: string
  
  The path for the resource.
Returns Promise<R>
- Defined in rest/src/RESTManager.ts:157

fetch

fetch<R, B, P>(path: string, method: string, options?: FetchOptions<B, P>, retries?: number): Promise<R>
Make a request to the REST API.

Returns
The response from the REST API.

Example
```
rest.request('/channels/abc', 'GET');
```
Type Parameters
- R = any
- B = any
- P extends Record<string, any> = Record<string, any>
Parameters
- path: string
  
  The path to the resource.
- method: string
  
  The HTTP method.
- options: FetchOptions<B, P> = {}
  
  The options for the request.
- retries: number = 0
  
  The number of retries.
Returns Promise<R>
- Defined in rest/src/RESTManager.ts:57

get

get<R, P>(path: string, params?: P): Promise<R>
Make a GET request to the REST API.

Returns
The response from the REST API.

Example
```
rest.get('/channels/abc');
```
Type Parameters
- R = any
- P extends Record<string, any> = Record<string, any>
Parameters
- path: string
  
  The path to the resource.
- Optional params: P
  
  The query parameters for the request.
Returns Promise<R>
- Defined in rest/src/RESTManager.ts:114

patch

patch<R, B>(path: string, body?: B): Promise<R>
Make a PATCH request to the REST API.

Returns
The response from the REST API.

Example
```
rest.patch('/channels/abc', { name: 'Chat' });
```
Type Parameters
- R = any
- B = any
Parameters
- path: string
  
  The path to the resource.
- Optional body: B
  
  The body for the request.
Returns Promise<R>
- Defined in rest/src/RESTManager.ts:136

post

post<R, B>(path: string, body?: B): Promise<R>
Make a POST request to the REST API.

Returns
The response from the REST API.

Example
```
rest.post('/channels', { name: 'Chat', type: 'chat' });
```
Type Parameters
- R = any
- B = any
Parameters
- path: string
  
  The path to the resource.
- Optional body: B
  
  The body for the request.
Returns Promise<R>
- Defined in rest/src/RESTManager.ts:125

put

put<R, B>(path: string, body?: B): Promise<R>
Make a PUT request to the REST API.

Returns
The response from the REST API.

Example
```
rest.put('/channels/abc/messages/abc', { content: 'Hello world!' });
```
Type Parameters
- R = any
- B = any
Parameters
- path: string
  
  The path to the resource.
- Optional body: B
  
  The body for the request.
Returns Promise<R>
- Defined in rest/src/RESTManager.ts:147

setToken

setToken(token?: string): RESTManager
Set the auth token for the REST API.

Returns
The REST manager.

Example
```
rest.setToken('token');
```
Parameters
- Optional token: string
  
  The auth token.
Returns RESTManager
- Defined in rest/src/RESTManager.ts:43

Class RESTManager

Example

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: RESTOptions

Returns RESTManager

Properties

Readonly options

Optional Readonly proxyUrl

Readonly router

Optional token

Optional Readonly version

Accessors

baseURL

Returns string

Methods

delete

Returns

Example

Type Parameters

R

Parameters

path: string

Returns Promise<R>

fetch

Returns

Example

Type Parameters

R = any

B = any

P extends Record<string, any> = Record<string, any>

Parameters

path: string

method: string

options: FetchOptions<B, P> = {}

retries: number = 0

Returns Promise<R>

get

Returns

Example

Type Parameters

R = any

P extends Record<string, any> = Record<string, any>

Parameters

path: string

Optional params: P

Returns Promise<R>

patch

Returns

Example

Type Parameters

R = any

B = any

Parameters

path: string

Optional body: B

Returns Promise<R>

post

Returns

Example

Type Parameters

R = any

B = any

Parameters

path: string

Optional body: B

Returns Promise<R>

put

Returns

Example

Type Parameters

R = any

B = any

`Readonly` options

`Optional` `Readonly` proxyUrl

`Readonly` router

`Optional` token

`Optional` `Readonly` version

`Optional` params: P

`Optional` body: B

`Optional` body: B

`Optional` body: B

`Optional` token: string