Interface GetOptions

Options for a Get function

interface GetOptions {
    attachment?: IntoZBytes;
    congestion_control?: CongestionControl;
    consolidation?: ConsolidationMode;
    encoding?: Encoding;
    express?: boolean;
    handler?: Handler | ((sample: Reply) => Promise<void>);
    payload?: IntoZBytes;
    priority?: Priority;
    target?: QueryTarget;
    timeout?: TimeDuration;
}

Properties

attachment? congestion_control? consolidation? encoding? express? handler? payload? priority? target? timeout?

Properties

Optionalattachment

attachment?: IntoZBytes

Additional Data sent with the request

Optionalcongestion_control

congestion_control?: CongestionControl

congestion_control applied when routing the data

Optionalconsolidation

consolidation?: ConsolidationMode

consolidation mode

Optionalencoding

encoding?: Encoding

Encoding type of payload

Optionalexpress

express?: boolean

Express

Optionalhandler

handler?: Handler | ((sample: Reply) => Promise<void>)

either a callback or a polling handler with an underlying handling mechanism

Optionalpayload

payload?: IntoZBytes

Payload associated with getrequest

Optionalpriority

priority?: Priority

priority of the written data

Optionaltarget

target?: QueryTarget

Optionaltimeout

timeout?: TimeDuration

Timeout value for a get request

Settings

Member Visibility

On This Page

Properties