Class RestClient

constructor

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

  Parameters

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

  Returns RestClient

Readonlyconnection

Readonlyendpoint

delete

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

  Parameters

  • Optionalresource: string
  • Optionaloptions: RestClientOptions

  Returns Promise<number>

extraHeader

• extraHeader(name: string): 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: string, value: string | number): this

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

  Parameters

  • name: string

    header name

  • value: string | number

  Returns this

get

• get<T extends HttpResponse>(
      resource: undefined | string,
      options: RestClientOptions & { rawResponse: true },
  ): Promise<T>

  Type Parameters

  • T extends HttpResponse

  Parameters

  • resource: undefined | string
  • options: RestClientOptions & { rawResponse: true }

  Returns Promise<T>

• get<T>(
      resource?: string,
      options?: RestClientOptions & { rawResponse?: false },
  ): Promise<T>

  Type Parameters

  • T

  Parameters

  • Optionalresource: string
  • Optionaloptions: RestClientOptions & { rawResponse?: false }

  Returns Promise<T>

patch

• patch(
      body: string | object,
      resource: undefined | string,
      options: RestClientOptions & { rawResponse: true },
  ): Promise<HttpResponse>

  Parameters

  • body: string | object
  • resource: undefined | string
  • options: RestClientOptions & { rawResponse: true }

  Returns Promise<HttpResponse>

• patch<T>(
      body: string | object,
      resource?: string,
      options?: RestClientOptions & { rawResponse?: false },
  ): Promise<T>

  Type Parameters

  • T

  Parameters

  • body: string | object
  • Optionalresource: string
  • Optionaloptions: RestClientOptions & { rawResponse?: false }

  Returns Promise<T>

post

• post(
      body: string | object | HttpRequestPart[],
      resource: undefined | string,
      options: RestClientOptions & { rawResponse: true },
  ): Promise<HttpResponse>

  Parameters

  • body: string | object | HttpRequestPart[]
  • resource: undefined | string
  • options: RestClientOptions & { rawResponse: true }

  Returns Promise<HttpResponse>

• post<T>(
      body: string | object | HttpRequestPart[],
      resource?: string,
      options?: RestClientOptions & { rawResponse?: false },
  ): Promise<T>

  Type Parameters

  • T

  Parameters

  • body: string | object | HttpRequestPart[]
  • Optionalresource: string
  • Optionaloptions: RestClientOptions & { rawResponse?: false }

  Returns Promise<T>

put

• put(
      body: string | object,
      resource: undefined | string,
      options: RestClientOptions & { rawResponse: true },
  ): Promise<HttpResponse>

  Parameters

  • body: string | object
  • resource: undefined | string
  • options: RestClientOptions & { rawResponse: true }

  Returns Promise<HttpResponse>

• put<T>(
      body: string | object,
      resource?: string,
      options?: RestClientOptions & { rawResponse?: false },
  ): Promise<T>

  Type Parameters

  • T

  Parameters

  • body: string | object
  • Optionalresource: string
  • Optionaloptions: RestClientOptions & { rawResponse?: false }

  Returns Promise<T>