Class SelectorHint

Schema for extra information on the selector.

Index

Constructors

Properties

indexableFields type unindexableFields

Methods

deserialize serialize

Constructors

constructor

new SelectorHint(): SelectorHint
Returns SelectorHint

Properties

indexableFields

indexableFields: string[]

A list of fields in the given selector that can be used to restrict the query.

type

type: string

A type of the index.

unindexableFields

unindexableFields: string[]

A list of fields in the given selector that can't be used to restrict the query.

Methods

`Static` deserialize

deserialize(obj): SelectorHint
Parameters
- obj: any
Returns SelectorHint
- Defined in cloudant/v1.ts:17154

`Static` serialize

serialize(obj): CloudantV1.SelectorHint.Transport
Parameters
- obj: any
Returns CloudantV1.SelectorHint.Transport
- Defined in cloudant/v1.ts:17137