Version: Next

LogGetOptions

Options for LogClient.get.

Hierarchy

LogOptions
- LogGetOptions

Index

Properties

buffer
raw
signal
timeoutSecs

Properties

optionalbuffer

buffer?: boolean = false

If true, the log is returned as a Buffer (Node.js) or ArrayBuffer (browser) instead of a string. It only selects the return type; to read the log incrementally, use LogClient.stream.

optionalinheritedraw

raw?: boolean = false

optionalinheritedsignal

signal?: AbortSignal

Aborts the method. Once the signal aborts, the request in flight is ended, no retry or further poll follows, and the method rejects with the signal's reason.

optionalinheritedtimeoutSecs

timeoutSecs?: Timeout

Timeout for the API request: a tier name ('short', 'medium', 'long'), a number of seconds, or 'noTimeout'. Defaults to the tier the method is assigned, which its documentation names.