Class FindResult

Schema for the result of a query find operation.

Index

Constructors

constructor

new FindResult(): FindResult
Returns FindResult

Properties

bookmark

bookmark: string

Opaque bookmark token used when paginating results.

docs

docs: Document[]

Documents matching the selector.

`Optional` executionStats

executionStats?: ExecutionStats

Schema for find query execution statistics.

`Optional` warning

warning?: string

warning.

Methods

`Static` deserialize

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

`Static` serialize

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

Class FindResult

Index

Constructors

Properties

Methods

Constructors

constructor

Returns FindResult

Properties

bookmark

docs

`Optional` executionStats

`Optional` warning

Methods

`Static` deserialize

Parameters

Returns FindResult

`Static` serialize

Parameters

Returns CloudantV1.FindResult.Transport

Settings

Member Visibility

Theme

On This Page

Class FindResult

Index

Constructors

Properties

Methods

Constructors

constructor

Returns FindResult

Properties

bookmark

docs

Optional executionStats

Optional warning

Methods

Static deserialize

Parameters

Returns FindResult

Static serialize

Parameters

Returns CloudantV1.FindResult.Transport

Settings

Member Visibility

Theme

On This Page

`Optional` executionStats

`Optional` warning

`Static` deserialize

`Static` serialize