API Reference

Class: ObservableSubscription

ROS2.0 JavaScript client with Node.js

class

ObservableSubscription()

Source:

Members

member

isDestroyed :boolean

Check if this observable subscription has been destroyed.
Type:
  • boolean
Source:
member

observable :Observable

Get the RxJS Observable for this subscription. Use this to pipe operators and subscribe to messages.
Type:
  • Observable
Source:
member

subscription :Subscription

Get the underlying ROS 2 subscription.
Type:
Source:
member

topic :string

Get the topic name.
Type:
  • string
Source:

Methods

function

complete()

Complete the observable and clean up resources. After calling this, no more messages will be emitted.
Source:
function

destroy()

Alias for complete() for consistency with RxJS naming.
Source:
class

ObservableSubscription(subscription)

class

new ObservableSubscription(subscription)

Create an ObservableSubscription wrapper.
Parameters:
Name Type Description
subscription Subscription The underlying ROS 2 subscription
Source:

Members

member

isDestroyed :boolean

Check if this observable subscription has been destroyed.
Type:
  • boolean
Source:
member

observable :Observable

Get the RxJS Observable for this subscription. Use this to pipe operators and subscribe to messages.
Type:
  • Observable
Source:
member

subscription :Subscription

Get the underlying ROS 2 subscription.
Type:
Source:
member

topic :string

Get the topic name.
Type:
  • string
Source:

Methods

function

complete()

Complete the observable and clean up resources. After calling this, no more messages will be emitted.
Source:
function

destroy()

Alias for complete() for consistency with RxJS naming.
Source: