Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TopicResultImpl<V>

Implementation of the TopicResult interface

Type parameters

  • V

Hierarchy

  • TopicResultImpl

Implements

Index

Constructors

constructor

  • Create a new TopicResultImpl instance

    Parameters

    • path: string

      the topic path

    • type: TopicType

      the topic type

    • value: V

      the value if one was requested

    • properties: object

      the topic properties

      • [key: string]: string

    Returns TopicResultImpl

Properties

Private mPath

mPath: string

The topic path

Private mProperties

mProperties: object

The topic properties

Type declaration

  • [key: string]: string

Private mType

mType: TopicType

The topic type

Private mValue

mValue: V

The value if one was requested

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