Class FindResult

Schema for the result of a query find operation.

Index

Constructors

Properties

bookmark docs executionStats? warning?

Methods

deserialize serialize

Constructors

constructor

new FindResult(): CloudantV1.FindResult
Returns CloudantV1.FindResult

Properties

bookmark

bookmark: string

Opaque bookmark token used when paginating results.

docs

docs: CloudantV1.Document[]

Documents matching the selector.

`Optional`executionStats

executionStats?: CloudantV1.ExecutionStats

Schema for find query execution statistics.

`Optional`warning

warning?: string

warning.

Methods

`Static`deserialize

deserialize(obj: any): CloudantV1.FindResult
Parameters
- obj: any
Returns CloudantV1.FindResult
- Defined in cloudant/v1.ts:14702

`Static`serialize

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