Search
Preparing search index...
The search index is not available
rest-resource
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
Globals
"client"
DefaultClient
Class DefaultClient
Hierarchy
BaseClient
DefaultClient
Index
Constructors
constructor
Properties
axios
hostname
Methods
delete
detail
get
head
list
negotiate
Content
on
Error
options
patch
post
put
extend
Constructors
constructor
new
Default
Client
(
baseURL
:
string
, config
?:
AxiosRequestConfig
)
:
DefaultClient
Parameters
baseURL:
string
Default value
config:
AxiosRequestConfig
= {}
Returns
DefaultClient
Properties
axios
axios
:
AxiosInstance
hostname
hostname
:
string
Methods
delete
delete
(
path
:
string
, options
?:
AxiosRequestConfig
)
:
Promise
<
any
>
Parameters
path:
string
Default value
options:
AxiosRequestConfig
= {}
Returns
Promise
<
any
>
detail
detail<T>
(
ResourceClass
:
T
, id
:
string
, options
?:
RequestConfig
)
:
Promise
<
ResourceResponse
<
InstanceType<T>
,
any
>
>
Type parameters
T
:
Resource
Parameters
ResourceClass:
T
id:
string
Default value
options:
RequestConfig
= {}
Returns
Promise
<
ResourceResponse
<
InstanceType<T>
,
any
>
>
get
get
(
path
:
string
, options
?:
any
)
:
AxiosPromise
<
any
>
Parameters
path:
string
Default value
options:
any
= {}
Returns
AxiosPromise
<
any
>
head
head
(
path
:
string
, options
?:
AxiosRequestConfig
)
:
Promise
<
any
>
Parameters
path:
string
Default value
options:
AxiosRequestConfig
= {}
Returns
Promise
<
any
>
list
list<T>
(
ResourceClass
:
T
, options
?:
RequestConfig
)
:
ListResponse
<
T
>
Type parameters
T
:
Resource
Parameters
ResourceClass:
T
Default value
options:
RequestConfig
= {}
Returns
ListResponse
<
T
>
negotiate
Content
negotiate
Content<T>
(
ResourceClass
:
T
)
:
ExtractorFunction
<
InstanceType
<
T
>
>
Type parameters
T
:
Resource
Parameters
ResourceClass:
T
Returns
ExtractorFunction
<
InstanceType
<
T
>
>
on
Error
on
Error
(
exception
:
Error
|
AxiosError
)
:
any
Parameters
exception:
Error
|
AxiosError
Returns
any
options
options
(
path
:
string
, options
?:
AxiosRequestConfig
)
:
any
Parameters
path:
string
Default value
options:
AxiosRequestConfig
= {}
Returns
any
patch
patch
(
path
:
string
, body
?:
any
, options
?:
AxiosRequestConfig
)
:
Promise
<
any
>
Parameters
path:
string
Default value
body:
any
= {}
Default value
options:
AxiosRequestConfig
= {}
Returns
Promise
<
any
>
post
post
(
path
:
string
, body
?:
any
, options
?:
AxiosRequestConfig
)
:
Promise
<
any
>
Parameters
path:
string
Default value
body:
any
= {}
Default value
options:
AxiosRequestConfig
= {}
Returns
Promise
<
any
>
put
put
(
path
:
string
, body
?:
any
, options
?:
AxiosRequestConfig
)
:
Promise
<
any
>
Parameters
path:
string
Default value
body:
any
= {}
Default value
options:
AxiosRequestConfig
= {}
Returns
Promise
<
any
>
Static
extend
extend<T, U>
(
this
:
U
, classProps
:
T
)
:
U
&
T
Type parameters
T
U
Parameters
this:
U
classProps:
T
Returns
U
&
T
Globals
Internals
"index"
Externals
"client"
"exceptions"
"helpers/normalization"
"related"
"util"
Base
Client
Default
Client
constructor
axios
hostname
delete
detail
get
head
list
negotiate
Content
on
Error
options
patch
post
put
extend
JWTBearer
Client
Request
Config
Resource
Response
Extractor
Function
Generated using
TypeDoc