Interfaces
Methods
(static) getFormat(type) → {object|null}
Gets the registered format for the given mime-type
Parameters:
| Name | Type | Description |
|---|---|---|
type |
string | The mime-type for the format. |
- Source:
Returns:
The format object for the given format type or null,
if no format was registered for that type.
- Type
- object | null
(static) getSupportedTypes() → {Array.<string>}
Function to return the mime-types that are supported by the currently
registered formats.
- Source:
Returns:
The supported format mime-types.
- Type
- Array.<string>
(static) registerFormat(type, format)
Register a format parser for a given mime-type.
Parameters:
| Name | Type | Description |
|---|---|---|
type |
string | The mime-type for the format. |
format |
object | The format parser. Shall have a 'parse' method. |
- Source:
Type Definitions
Record
Type:
- Object
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
id |
string | The id of the record | |
properties |
object | The parsed properties of the record | |
geometry |
object |
<optional> |
The parsed record geometry |
bbox |
Array.<float> |
<optional> |
The parsed record geometry |
- Source:
SearchResult
Type:
- Object
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
totalResults |
int |
<optional> |
The total amount of matched records |
startIndex |
int |
<optional> |
The start index of this response |
itemsPerPage |
int |
<optional> |
The number of items per page of results |
query |
object |
<optional> |
The query of this result |
links |
Array.<object> |
<optional> |
Relevant links of this result |
records |
Array.<module:opensearch/formats.Record> | The parsed records |
- Source:
Suggestion
Type:
- Object
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
completion |
string | The completion value | |
description |
string |
<optional> |
A description of the completion |
url |
string |
<optional> |
The search URL for that completion |
- Source: