Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FetchRequestOptions

Internal options for the FetchRequestImpl builder

Hierarchy

  • FetchRequestOptions

Index

Properties

Optional dataType

dataType: DataType<any, any, any>

Optional data type when values are requested

deepBranchDepth

deepBranchDepth: number

The minimum number of parts in a path that belongs to a "deep" branch

deepBranchLimit

deepBranchLimit: number

The maximum number of paths to return for each deep branch

limit

limit: number

The limit for the number of results returned. A value of 0 indicates no result. A positive value indicates a limit from the start of the selection and a negative value indicates a limit from the end of the selection.

maximumResultSize

maximumResultSize: number

Limit on the response size in bytes

range

range: FetchRange

The range of topics to fetch

topicTypes

topicTypes: Set<TopicType>

The topic types to fetch

withProperties

withProperties: boolean

Flag indicating if properties are requested

withUnpublishedDelayedTopics

withUnpublishedDelayedTopics: boolean

Whether unpublished delayed topics should be included in the results.