Class RestManager

constructor

• new RestManager(options): RestManager

• Parameters

  • options: RestOptions

  Returns RestManager

Readonly emitter

Readonly options

proxyURL

Readonly router

token

version

baseURL

• get baseURL(): string

• The base url to send the request to.

  Returns string

obfuscatedToken

• get obfuscatedToken(): string

• Generate obfuscated token. It replaces every char in a non-even index with X. I'm not very creative.

  Returns string

delete

• delete<T, B>(path, body?, authenticated?): Promise<T>

• Type Parameters

  • T extends JSONB

  • B = RequestBodyObject

  Parameters

  • path: string

  • Optional body: B

  • authenticated: boolean = true

  Returns Promise<T>

get

• get<T, Q>(path, query?, authenticated?): Promise<T>

• Type Parameters

  • T extends JSONB

  • Q = RequestBodyObject

  Parameters

  • path: string

  • Optional query: Q

  • authenticated: boolean = true

  Returns Promise<T>

make

• make<T, B, Q>(data, authenticated?, retryCount?, options?): Promise<[Response, Promise<string | T>]>

• Type Parameters

  • T extends JSONB

  • B = RequestBodyObject

  • Q = never

  Parameters

  • data: MakeOptions<B, Q>

  • authenticated: boolean = true

  • retryCount: number = 0

  • options: {
        bodyIsJSON?: boolean;
        returnAsText?: boolean;
    } = {}

    • Optional bodyIsJSON?: boolean

    • Optional returnAsText?: boolean

  Returns Promise<[Response, Promise<string | T>]>

patch

• patch<T, B>(path, body, authenticated?): Promise<T>

• Type Parameters

  • T extends JSONB

  • B = RequestBodyObject

  Parameters

  • path: string

  • body: B

  • authenticated: boolean = true

  Returns Promise<T>

post

• post<T, B>(path, body?, authenticated?): Promise<T>

• Type Parameters

  • T extends JSONB

  • B = RequestBodyObject

  Parameters

  • path: string

  • Optional body: B

  • authenticated: boolean = true

  Returns Promise<T>

put

• put<T, B>(path, body?, authenticated?): Promise<T>

• Type Parameters

  • T extends JSONB

  • B = RequestBodyObject

  Parameters

  • path: string

  • Optional body: B

  • authenticated: boolean = true

  Returns Promise<T>