Library Documentation
NPM
GitHub
Preparing search index...
The search index is not available
Amplify JS API Documentation
Amplify JS API Documentation
aws-amplify
api
<Reference Types>
ClientCustomType
Interface ClientCustomType<Bag, T>
interface
ClientCustomType
<
Bag
,
T
>
{
__entityType
:
"customType"
;
type
:
ShallowPretty
<
{
[
K
in
string
|
number
|
symbol
as
IsRequired
<
T
[
"fields"
]
[
K
]
>
extends
true
?
K
:
never
]
:
ResolveIndividualField
<
Bag
,
T
[
"fields"
]
[
K
]
>
}
&
{
[
K
in
string
|
number
|
symbol
as
IsRequired
<
T
[
"fields"
]
[
K
]
>
extends
true
?
never
:
K
]
?:
ResolveIndividualField
<
Bag
,
T
[
"fields"
]
[
K
]
>
}
>
;
}
Type Parameters
Bag
extends
Record
<
string
,
unknown
>
T
extends
CustomTypeParamShape
Hierarchy (
view full
)
ClientSchemaProperty
ClientCustomType
Index
Properties
__entity
Type
type
Properties
__entity
Type
__entity
Type
:
"customType"
type
type
:
ShallowPretty
<
{
[
K
in
string
|
number
|
symbol
as
IsRequired
<
T
[
"fields"
]
[
K
]
>
extends
true
?
K
:
never
]
:
ResolveIndividualField
<
Bag
,
T
[
"fields"
]
[
K
]
>
}
&
{
[
K
in
string
|
number
|
symbol
as
IsRequired
<
T
[
"fields"
]
[
K
]
>
extends
true
?
never
:
K
]
?:
ResolveIndividualField
<
Bag
,
T
[
"fields"
]
[
K
]
>
}
>
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
On This Page
__entity
Type
type
Amplify JS API Documentation
aws-amplify
@aws-amplify
geo
interactions
predictions
pubsub
adapter-nextjs
datastore-storage-adapter