Options
All
  • Public
  • Public/Protected
  • All
Menu

Parameters for the getDbUpdates operation.

Hierarchy

  • GetDbUpdatesParams

Index

Properties

Optional feed

feed: string

Query parameter to specify the changes feed type.

Optional headers

headers: OutgoingHttpHeaders

Optional heartbeat

heartbeat: number

Query parameter to specify the period in milliseconds after which an empty line is sent in the results. Only applicable for longpoll, continuous, and eventsource feeds. Overrides any timeout to keep the feed alive indefinitely. May also be true to use default value of 60000.

Optional since

since: string

Query parameter to specify to start the results from the change immediately after the given update sequence. Can be a valid update sequence or now value. Default is 0 i.e. all changes.

Optional timeout

timeout: number

Query parameter to specify the maximum period in milliseconds to wait for a change before the response is sent, even if there are no results. Only applicable for longpoll or continuous feeds. Default value is specified by httpd/changes_timeout configuration option. Note that 60000 value is also the default maximum timeout to prevent undetected dead connections.

Generated using TypeDoc