kumo-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Kumo Client

npm version commits since latest version milestone build and test status doc and deploy status

JavaScript client library for Kumo WebSocket to ROS 2 bridge.

Documentation

You can read the full API documentation in the generated docs directory or in here.

Usage

See examples for information on how to use this library.

Make sure the Kumo bridge server is already running.

License

This project is maintained by ICHIRO ITS and licensed under the MIT License.

Index

Type aliases

ConnectCallback

ConnectCallback: function

Type declaration

DisconnectCallback

DisconnectCallback: function

Type declaration

    • (code: number, reason: string): void
    • Parameters

      • code: number
      • reason: string

      Returns void

ErrorCallback

ErrorCallback: function

Type declaration

    • (err: Error): void
    • Parameters

      • err: Error

      Returns void

ServiceCallback

ServiceCallback: function

Type declaration

    • (request: any): any | Promise<any>
    • Parameters

      • request: any

      Returns any | Promise<any>

SubscriptionCallback

SubscriptionCallback: function

Type declaration

    • (message: any): void | Promise<void>
    • Parameters

      • message: any

      Returns void | Promise<void>

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc