@bjornharrtell/json-api
Preparing search index...
useJsonApi
Function useJsonApi
useJsonApi
(
config
:
JsonApiConfig
,
fetcher
?:
JsonApiFetcherImpl
,
)
:
{
createRecord
:
<
T
extends
BaseEntity
>
(
type
:
string
,
properties
:
Partial
<
T
>
&
{
id
?:
string
}
,
)
=>
T
;
findAll
:
<
T
extends
BaseEntity
>
(
type
:
string
,
options
?:
FetchOptions
,
params
?:
FetchParams
,
)
=>
Promise
<
{
doc
:
JsonApiDocument
;
records
:
T
[]
}
>
;
findRecord
:
<
T
extends
BaseEntity
>
(
type
:
string
,
id
:
string
,
options
?:
FetchOptions
,
params
?:
FetchParams
,
)
=>
Promise
<
T
>
;
findRelated
:
(
record
:
BaseEntity
,
relationshipName
:
string
,
options
?:
FetchOptions
,
params
?:
FetchParams
,
)
=>
Promise
<
JsonApiDocument
>
;
saveAtomic
:
(
operations
:
AtomicOperation
[]
,
options
?:
FetchOptions
,
)
=>
Promise
<
{
doc
:
JsonApiAtomicResults
;
records
:
BaseEntity
[]
}
>
;
saveRecord
:
<
T
extends
BaseEntity
>
(
record
:
BaseEntity
,
options
?:
FetchOptions
,
)
=>
Promise
<
T
>
;
}
Parameters
config
:
JsonApiConfig
Optional
fetcher
:
JsonApiFetcherImpl
Returns
{
createRecord
:
<
T
extends
BaseEntity
>
(
type
:
string
,
properties
:
Partial
<
T
>
&
{
id
?:
string
}
,
)
=>
T
;
findAll
:
<
T
extends
BaseEntity
>
(
type
:
string
,
options
?:
FetchOptions
,
params
?:
FetchParams
,
)
=>
Promise
<
{
doc
:
JsonApiDocument
;
records
:
T
[]
}
>
;
findRecord
:
<
T
extends
BaseEntity
>
(
type
:
string
,
id
:
string
,
options
?:
FetchOptions
,
params
?:
FetchParams
,
)
=>
Promise
<
T
>
;
findRelated
:
(
record
:
BaseEntity
,
relationshipName
:
string
,
options
?:
FetchOptions
,
params
?:
FetchParams
,
)
=>
Promise
<
JsonApiDocument
>
;
saveAtomic
:
(
operations
:
AtomicOperation
[]
,
options
?:
FetchOptions
,
)
=>
Promise
<
{
doc
:
JsonApiAtomicResults
;
records
:
BaseEntity
[]
}
>
;
saveRecord
:
<
T
extends
BaseEntity
>
(
record
:
BaseEntity
,
options
?:
FetchOptions
,
)
=>
Promise
<
T
>
;
}
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
@bjornharrtell/json-api
Loading...