Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TopicResult<V>

Encapsulates the result of a fetch invocation for a single selected topic.

since

6.2

Type parameters

  • V

    the result value type. This will be any type unless the request indicated that values are to be returned, in which case this will be the data type requested.

Hierarchy

  • TopicResult

Implemented by

Index

Methods

path

  • path(): string
  • Returns the topic path.

    Returns string

    the topic path

specification

  • Returns the topic specification.

    If the request specified withProperties, the result reflect the topic's specification and can be used to create an identical topic. If the request did not specify withProperties, the specification's property map will be empty.

    Returns TopicSpecification

    the topic specification

type

  • Returns the topic type.

    Returns TopicType

    the topic type

value

  • value(): V
  • Returns the topic value.

    This will only return a value if the fetch request specified withValues and the topic actually had a value. For topics that have no value this will return undefined.

    Returns V

    the topic value or undefined if none available