Hierarchy

  • Options

Properties

body?: string
compressBodyIfPossible?: boolean

Gzip compress the post body only if the underlying SDK framework supports it and the config option enableEventCompression is set to true.

headers?: Record<string, string>
keepalive?: boolean

For use in browser environments. Platform support will be best effort for this field. https://developer.mozilla.org/en-US/docs/Web/API/RequestInit#keepalive

method?: string
signal?: AbortSignal

An abort signal for the request. When the signal aborts, the implementation stops the request and rejects any pending read. Platform support for this field is best effort.

https://developer.mozilla.org/en-US/docs/Web/API/RequestInit#signal

streaming?: boolean

True for a streaming request. The implementation does not buffer the response body, it does not request compressed content, and it ignores Options.timeout. The response exposes its body through Response.body. An SDK must use a fetch as a streaming transport only when the implementation honors this field. A streaming implementation must provide at least one release path. It honors Options.signal, or it provides the body cancel. It preferably provides both.

timeout?: number

Generated using TypeDoc