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>
IndexQueryMethodSignature
Type alias IndexQueryMethodSignature<Bag, Idx, ModelName>
Index
Query
Method
Signature
<
Bag
,
Idx
,
ModelName
>
:
Record
<
IsEmptyStringOrNever
<
Idx
[
"queryField"
]
>
extends
false
?
Idx
[
"queryField"
]
:
`
list
${
ModelName
}
By
${
Idx
[
"defaultQueryFieldSuffix"
]
}
`
,
{
input
:
IndexQueryInput
<
Bag
,
Idx
>
;
}
>
Type Parameters
Bag
extends
Record
<
string
,
unknown
>
Idx
extends
SecondaryIndexIrShape
ModelName
extends
string
Type declaration
input
:
IndexQueryInput
<
Bag
,
Idx
>
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
Amplify JS API Documentation
aws-amplify
@aws-amplify
geo
interactions
predictions
pubsub
adapter-nextjs
datastore-storage-adapter