typescript-api-platform
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Abstract
Api
Resource
Abstract
Data
Abstract
Data
Resource
Abstract
Entity
Resource
constructor
axios
object
Factory
create
delete
delete
From
Object
get
get
From
Object
get
IdPath
Representation
get
Object
Id
get
Path
get
Path
From
Object
list
update
wrap
Hydra
Item
wrap
Promise
Abstract
Get
Entity
Resource
Abstract
Resource
Default
Data
Resource
Id
Data
Message
Api
Search
Api
Sort
Axios
Response
Ext
Get
One
Options
Get
Options
Page
configure
Cancel
configure
Page
create
Props
Params
Type parameters
T
K
Hierarchy
AbstractGetEntityResource
<
T
,
K
>
AbstractEntityResource
AbstractDataResource
Index
Constructors
constructor
Properties
axios
object
Factory
Methods
create
delete
delete
From
Object
get
get
From
Object
get
IdPath
Representation
get
Object
Id
get
Path
get
Path
From
Object
list
update
wrap
Hydra
Item
wrap
Promise
Constructors
constructor
new
Abstract
Entity
Resource
(
axios
:
AxiosInstance
, prefix
:
string
)
:
AbstractEntityResource
Parameters
axios:
AxiosInstance
prefix:
string
Returns
AbstractEntityResource
Properties
Protected
axios
axios
:
AxiosInstance
Protected
Optional
object
Factory
object
Factory
:
undefined
|
function
Methods
create
create
(
object
:
T
)
:
Promise
<
T
&
AxiosResponseExt
>
Parameters
object:
T
Returns
Promise
<
T
&
AxiosResponseExt
>
delete
delete
(
id
:
K
)
:
Promise
<
T
&
AxiosResponseExt
>
Parameters
id:
K
Returns
Promise
<
T
&
AxiosResponseExt
>
delete
From
Object
delete
From
Object
(
object
:
T
)
:
Promise
<
T
&
AxiosResponseExt
>
Parameters
object:
T
Returns
Promise
<
T
&
AxiosResponseExt
>
get
get
(
id
:
K
, cancelTokenSource
?:
CancelTokenSource
)
:
Promise
<
T
&
AxiosResponseExt
>
Parameters
id:
K
Optional
cancelTokenSource:
CancelTokenSource
Returns
Promise
<
T
&
AxiosResponseExt
>
get
From
Object
get
From
Object
(
object
:
T
)
:
Promise
<
T
&
AxiosResponseExt
>
Parameters
object:
T
Returns
Promise
<
T
&
AxiosResponseExt
>
get
IdPath
Representation
get
IdPath
Representation
(
id
:
K
)
:
string
Parameters
id:
K
Returns
string
Abstract
get
Object
Id
get
Object
Id
(
object
:
T
)
:
K
Parameters
object:
T
Returns
K
get
Path
get
Path
(
id
?:
K
)
:
string
Parameters
Optional
id:
K
Returns
string
get
Path
From
Object
get
Path
From
Object
(
object
?:
T
)
:
string
Parameters
Optional
object:
T
Returns
string
list
list
(
cancelTokenSource
?:
CancelTokenSource
)
:
Promise
<
T
[]
&
AxiosResponseExt
>
Parameters
Optional
cancelTokenSource:
CancelTokenSource
Returns
Promise
<
T
[]
&
AxiosResponseExt
>
update
update
(
object
:
T
)
:
Promise
<
T
&
AxiosResponseExt
>
Parameters
object:
T
Returns
Promise
<
T
&
AxiosResponseExt
>
Protected
wrap
Hydra
Item
wrap
Hydra
Item
(
data
:
any
)
:
any
&
object
Parameters
data:
any
Returns
any
&
object
Protected
wrap
Promise
wrap
Promise
(
axiosPromise
:
AxiosPromise
, objectFactory
?:
undefined
|
function
)
:
Promise
<
Object
>
Parameters
axiosPromise:
AxiosPromise
Optional
objectFactory:
undefined
|
function
Returns
Promise
<
Object
>
Generated using
TypeDoc