Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GetOptions

Hierarchy

  • GetOptions

Index

Properties

Optional parentSpan

parentSpan: RequestSpan

The parent tracing span that this operation will be part of.

Optional project

project: string[]

Specifies a list of fields within the document which should be fetched. This allows for easy retrieval of select fields without incurring the overhead of fetching the whole document.

Optional timeout

timeout: number

The timeout for this operation, represented in milliseconds.

Optional transcoder

transcoder: Transcoder

Specifies an explicit transcoder to use for this specific operation.

Optional withExpiry

withExpiry: boolean

Indicates that the expiry of the document should be fetched alongside the data itself.

Generated using TypeDoc