Preparing search index...
The search index is not available
@spinque/query-api
@spinque/query-api
OptionsResponse
Interface OptionsResponse
Response to a Query for facet options
Hierarchy
OptionsResponse
Index
Properties
id
options
selected
title
Properties
id
id
:
string
Name of the facet options endpoint
options
options
:
{
id
:
string
;
score
:
number
;
title
:
string
;
value
:
string
;
}
[]
Type declaration
id
:
string
score
:
number
title
:
string
value
:
string
selected
selected
:
{
id
:
string
;
score
:
number
;
title
:
string
;
value
:
string
;
}
[]
Type declaration
id
:
string
score
:
number
title
:
string
value
:
string
title
title
:
string
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
On This Page
id
options
selected
title
@spinque/query-
api
Facet
Type
Request
Type
Api
Api
Not
Found
Error
Authenticator
Client
Credentials
Endpoint
Not
Found
Error
Error
Response
Faceted
Search
Filtered
Search
PKCE
Server
Error
Unauthorized
Error
Workspace
Config
Not
Found
Error
Api
Config
Cluster
Count
And
Offset
Count
Response
Facet
Filter
Options
Response
Parameterized
Filter
Query
Result
Item
Results
Response
Simple
Filter
Snippet
Options
Spinque
Result
Object
Statistics
Response
Token
Cache
Api
Authentication
Config
Data
Type
Facet
Filter
Language
Options
Request
Options
Options
Type
Response
Type
Result
Item
Request
Options
Result
Object
Results
And
Count
Response
Results
Request
Options
Tuple
Types
DEFAULT_
AUTH_
SERVER
DEFAULT_
BASE_
URL
is
Browser
local
Storage
Token
Cache
api
Status
Url
api
Url
get
Clusters
get
Snippet
is
Cluster
is
Tuple
List
join
parse
Queries
path
From
Queries
path
From
Query
split
Into
Sentences
string
To
Tuple
List
stringify
Queries
truncate
tuple
List
To
String
url
From
Queries
Generated using
TypeDoc
Response to a Query for facet options