Class: RESTClient

Defined in: client.ts:7

Extended by

• ApiService

Constructors

Constructor

new RESTClient(baseURL?): RESTClient;

Defined in: client.ts:11

Parameters

Parameter	Type	Default value
baseURL?	string	"/api/v1"

Returns

RESTClient

Methods

clearToken()

clearToken(): void;

Defined in: client.ts:56

clear authentication token

Returns

void

---

delete()

delete<T>(url, config?): Promise<T>;

Defined in: client.ts:109

generic delete request

Type Parameters

Type Parameter	Default type
T	any

Parameters

Parameter	Type
url	string
config?	AxiosRequestConfig<any, any>

Returns

Promise<T>

---

get()

get<T>(url, config?): Promise<T>;

Defined in: client.ts:77

generic get request

Type Parameters

Type Parameter	Default type
T	any

Parameters

Parameter	Type
url	string
config?	AxiosRequestConfig<any, any>

Returns

Promise<T>

---

getBaseURL()

getBaseURL(): string;

Defined in: client.ts:70

get current base url

Returns

string

---

patch()

patch<T>(
   url, 
   data?, 
   config?
): Promise<T>;

Defined in: client.ts:101

generic patch request

Type Parameters

Type Parameter	Default type
T	any

Parameters

Parameter	Type
url	string
data?	any
config?	AxiosRequestConfig<any, any>

Returns

Promise<T>

---

post()

post<T>(
   url, 
   data?, 
   config?
): Promise<T>;

Defined in: client.ts:85

generic post request

Type Parameters

Type Parameter	Default type
T	any

Parameters

Parameter	Type
url	string
data?	any
config?	AxiosRequestConfig<any, any>

Returns

Promise<T>

---

put()

put<T>(
   url, 
   data?, 
   config?
): Promise<T>;

Defined in: client.ts:93

generic put request

Type Parameters

Type Parameter	Default type
T	any

Parameters

Parameter	Type
url	string
data?	any
config?	AxiosRequestConfig<any, any>

Returns

Promise<T>

---

setBaseURL()

setBaseURL(baseURL): void;

Defined in: client.ts:63

set base url for api requests (for dynamic server configuration)

Parameters

Parameter	Type
baseURL	string

Returns

void

---

setClientKind()

setClientKind(kind): void;

Defined in: client.ts:48

say which of Refract's apps is making the requests. Only the mobile app says anything: the instance takes a request that doesn't for the desktop kind, which a browser is too.

Parameters

Parameter	Type
kind	IClientKind

Returns

void

---

setToken()

setToken(token): void;

Defined in: client.ts:39

set authentication token for subsequent requests

Parameters

Parameter	Type
token	string | null

Returns

void