GetAllDbsParams | @ibm-cloud/cloudant

Parameters for the getAllDbs operation.

Hierarchy

GetAllDbsParams

Index

Properties

descending
endkey
headers
limit
skip
startkey

Properties

Optional descending

descending?: boolean

Query parameter to specify whether to return the documents in descending by key order.

Optional endkey

endkey?: string

Query parameter to specify to stop returning records when the specified key is reached. String representation of any JSON type that matches the key type emitted by the view function.

Optional headers

headers?: OutgoingHttpHeaders

Optional limit

limit?: number

Query parameter to specify the number of returned documents to limit the result to.

Optional skip

skip?: number

Query parameter to specify the number of records before starting to return the results.

Optional startkey

startkey?: string

Query parameter to specify to start returning records from the specified key. String representation of any JSON type that matches the key type emitted by the view function.