Class RestClient

constructor

• new RestClient(connection, endpoint, contentType?): RestClient

• Parameters

  • connection: ServerConnection

  • endpoint: string

  • contentType: string = 'application/json; charset=utf-8'

  Returns RestClient

Readonly connection

Readonly endpoint

delete

• delete(resource?, options?): Promise<number>

• Parameters

  • Optional resource: string

  • Optional options: RestClientOptions

  Returns Promise<number>

extraHeader

• extraHeader(name): undefined | string | number

• Get the current value of a request header by the specified name.

  Parameters

  • name: string

    header name

  Returns undefined | string | number
• extraHeader(name, value): RestClient

• Add or override a request header that will be used for each re

  Parameters

  • name: string

    header name

  • value: string | number

  Returns RestClient

get

• get<T>(resource, options): Promise<T>

• Type Parameters

  • T extends HttpResponse

  Parameters

  • resource: undefined | string

  • options: RestClientOptions & {
        rawResponse: true;
    }

  Returns Promise<T>

• get<T>(resource?, options?): Promise<T>

• Type Parameters

  • T

  Parameters

  • Optional resource: string

  • Optional options: RestClientOptions & {
        rawResponse?: false;
    }

  Returns Promise<T>

patch

• patch(body, resource, options): Promise<HttpResponse>

• Parameters

  • body: string | object

  • resource: undefined | string

  • options: RestClientOptions & {
        rawResponse: true;
    }

  Returns Promise<HttpResponse>

• patch<T>(body, resource?, options?): Promise<T>

• Type Parameters

  • T

  Parameters

  • body: string | object

  • Optional resource: string

  • Optional options: RestClientOptions & {
        rawResponse?: false;
    }

  Returns Promise<T>

post

• post(body, resource, options): Promise<HttpResponse>

• Parameters

  • body: string | object | HttpRequestPart[]

  • resource: undefined | string

  • options: RestClientOptions & {
        rawResponse: true;
    }

  Returns Promise<HttpResponse>

• post<T>(body, resource?, options?): Promise<T>

• Type Parameters

  • T

  Parameters

  • body: string | object | HttpRequestPart[]

  • Optional resource: string

  • Optional options: RestClientOptions & {
        rawResponse?: false;
    }

  Returns Promise<T>

put

• put(body, resource, options): Promise<HttpResponse>

• Parameters

  • body: string | object

  • resource: undefined | string

  • options: RestClientOptions & {
        rawResponse: true;
    }

  Returns Promise<HttpResponse>

• put<T>(body, resource?, options?): Promise<T>

• Type Parameters

  • T

  Parameters

  • body: string | object

  • Optional resource: string

  • Optional options: RestClientOptions & {
        rawResponse?: false;
    }

  Returns Promise<T>